DataContextFactory.java

/**
 * 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.metamodel.factory;

import java.util.ServiceLoader;

import org.apache.metamodel.ConnectionException;
import org.apache.metamodel.DataContext;

/**
 * Represents a factory of {@link DataContext} objects. Factories take
 * {@link DataContextProperties} and turn them into active {@link DataContext}
 * instances.
 * 
 * Multiple factories can exist in order to serve different kinds of properties,
 * thereby offering a dynamic factory mechanism. The collection of factories is
 * accessible via {@link DataContextFactoryRegistry}.
 * 
 * These factories are registered via the Java {@link ServiceLoader} SPI API. So
 * add a file with path
 * "/META-INF/services/org.apache.metamodel.factory.DataContextFactory" in any
 * JAR file in order to register another factory.
 */
public interface DataContextFactory {

    public boolean accepts(DataContextProperties properties, ResourceFactoryRegistry resourceFactoryRegistry);

    public DataContext create(DataContextProperties properties, ResourceFactoryRegistry resourceFactoryRegistry)
            throws UnsupportedDataContextPropertiesException, ConnectionException;
}