RailsAdapterFactory.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 * Other names may be trademarks of their respective owners.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 * 
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 * 
 * Contributor(s):
 * 
 * Portions Copyrighted 2008 Sun Microsystems, Inc.
 */

package org.netbeans.modules.ruby.railsprojects.database;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import org.netbeans.api.ruby.platform.RubyPlatform;
import org.netbeans.modules.ruby.platform.gems.GemManager;

/**
 * A factory for Rails database adapters.
 *
 * @author Erno Mononen
 */
public class RailsAdapterFactory {
    
    /**
     * @return all known adapters for the given <code>plaform</code>.
     */
    public static List<RailsDatabaseConfiguration> getAdapters(RubyPlatform plaform) {
        List<RailsDatabaseConfiguration> result = new  ArrayList<RailsDatabaseConfiguration>();
        result.addAll(getMySQLAdapters(plaform));
        result.addAll(getPostgreSQLAdapters(plaform));
        result.add(new StandardRailsAdapter("oracle")); //NOI18N
        result.add(new SQLiteAdapter("sqlite2")); //NOI18N
        result.add(new SQLiteAdapter("sqlite3")); //NOI18N
        result.add(new JavaDBAdapter());
        return result;
    }

    private static List<RailsDatabaseConfiguration> getMySQLAdapters(RubyPlatform platform) {
        if (!platform.isJRuby()) {
            return Collections.<RailsDatabaseConfiguration>singletonList(new MySQLAdapter());
        }
        GemManager gemManager = platform.getGemManager();
        if (gemManager == null || !gemManager.isGemInstalled(JdbcMySQlAdapter.GEM_NAME)) {
            return Collections.<RailsDatabaseConfiguration>singletonList(new MySQLAdapter());
        }
        return Collections.<RailsDatabaseConfiguration>singletonList(new JdbcMySQlAdapter());
    }

    private static List<RailsDatabaseConfiguration> getPostgreSQLAdapters(RubyPlatform platform) {
        if (!platform.isJRuby()) {
            return Collections.<RailsDatabaseConfiguration>singletonList(new PostgreSQLAdapter());
        }
        GemManager gemManager = platform.getGemManager();
        if (gemManager == null || !gemManager.isGemInstalled(JdbcPostgreSQLAdapter.GEM_NAME)) {
            return Collections.<RailsDatabaseConfiguration>singletonList(new PostgreSQLAdapter());
        }
        return Collections.<RailsDatabaseConfiguration>singletonList(new JdbcPostgreSQLAdapter());
    }
    /**
     * Gets the default adapter, i.e. the adapter to be used when no configuration
     * is specified. The default adapter is MySQL.
     * 
     * @return the default adapter.
     */
    public static RailsDatabaseConfiguration getDefaultAdapter(RubyPlatform platform) {
        RailsDatabaseConfiguration defaultAdapter  = getAdapters(platform).get(0);
        return defaultAdapter.requiresJdbc()
                ? new ConfigurableRailsAdapter(defaultAdapter, null, null, null, true)
                : defaultAdapter;
    }

    // just for tests, returns the mysql adapter
    public static RailsDatabaseConfiguration getDefaultAdapter() {
        return new MySQLAdapter();
    }
    
}