org.apache.cayenne.dba.DbAdapterFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cayenne-client-nodeps

Cayenne Object Persistence Framework

There is a newer version: 2.0.4

/*****************************************************************
 *   Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 ****************************************************************/

package org.apache.cayenne.dba;

import java.sql.DatabaseMetaData;
import java.sql.SQLException;

/**
 * Defines a conditional factory for a specific DbAdapter. Note that the factory can
 * potentially return different (or differently configured) DbAdapters for the same
 * database based on version information and other metadata.
 * 
 * @since 1.2
 * @author Andrus Adamchik
 */
public interface DbAdapterFactory {

    /**
     * Returns an instance of DbAdapter if the factory detects that it knows how to handle
     * the database. Returns null if the database is not known to the factory, thus
     * allowing multiple factories to be chained.
     */
    DbAdapter createAdapter(DatabaseMetaData md) throws SQLException;
}