| gvSIG desktop 1

package org.gvsig.fmap.dal;

import java.util.List;

import org.gvsig.fmap.dal.exceptions.InitializeException;

import org.gvsig.fmap.dal.exceptions.ProviderNotRegisteredException;

import org.gvsig.fmap.dal.resource.ResourceManager;

import org.gvsig.tools.evaluator.Evaluator;

/**

 * This class contains the main DAL specific services. It provides functionality for 

 * registering and instantiating DataExplorer(s), DataStore(s), Evaluator(s) and FeatureIndex(es).

 * 

 * (note that resource management is {@link ResourceManager}'s responsibility)

 *

 */

public interface DataManager {

    /**

         * Returns the default DAL's temporary directory

         * 

         * @return Temporary directory name

         */

        public String getTemporaryDirectory();

        /*

         * ====================================================================

         *

         * Store related services

         */

        /**

         * Creates, initializes and returns an instance of DataStoreParameters given the name with which 

         * their provider is registered.

         *

         * @param String

         *            provider name

         * @throws InitializeException

         *             

         * @throws ProviderNotRegisteredException

         **/

        public DataStoreParameters createStoreParameters(String name)

                        throws InitializeException, ProviderNotRegisteredException;

        /**

         * 

         * Creates, initializes and returns an instance of DataStore given the DataStoreParameters.

         *

         * @param DataStoreParameters 

         *                                                 parameters used to instantiate and initialize the DataStore

         * @throws InitializeException

         * 

         * @throws ProviderNotRegisteredException

         **/

        public DataStore createStore(DataStoreParameters parameters)

                        throws InitializeException, ProviderNotRegisteredException;

        /**

         * Returns a list of Strings containing the names of all available 

         * DataStore providers.

         * 

         * @return list of String containing available DataStore provider names

         */

        public List getStoreProviders();

        /*

         * ====================================================================

         *

         * Explorer related services

         */

        /**

         * Start a instance with solicited parameters starts name in the instance

         * and returns it.

         *

         * @param String

         *            name

         * @throws InitializeException

         * @throws ProviderNotRegisteredException

         **/

        public DataExplorerParameters createExplorerParameters(

                        String name)

                        throws InitializeException, ProviderNotRegisteredException;

        /**

         * 

         * @param parameters

         * @return

         * @throws InitializeException

         * @throws ProviderNotRegisteredException

         */

        public DataExplorer createExplorer(

                        DataExplorerParameters parameters)

                        throws InitializeException, ProviderNotRegisteredException;

        /**

         * Returns a list of String containing the names of the available DataExplorer providers.

         * 

         * @return list of String containing the names of the available DataExplorer providers.

         */

        public List getExplorerProviders();

        /*

         * ====================================================================

         * 

         * Expression evaluation related services

         */

        /**

         * Registers the default expression evaluator. It is used by DAL to evaluate and resolve 

         * query filters and expressions.

         * 

         * @param evaluator 

         *                         Class that will be called to evaluate the expression. It must implement {@link Evaluator}.

         */

        public void registerDefaultEvaluator(Class evaluator);

        /**

         * Creates an instance of Evaluator that represents the given expression.

         * 

         * @param expresion String containing a CQL expression.

         * @return instance of Evaluator representing the given expression.

         * @throws InitializeException

         */

        public Evaluator createExpresion(String expresion)

                        throws InitializeException;

        /*

         * ====================================================================

         * 

         * Index related services

         */

        /**

         * Returns a list of String containing the names of the available index providers.

         *

         * @return list of strings with the names of the available index providers

         */

        public List getFeatureIndexProviders();

        /**

         * Sets the default DataIndexProvider for the given data type.

         * @param dataType one of the data types defined in the api package

         * @param name Provider's name

         */

    public void setDefaultFeatureIndexProviderName(int dataType, String name);

    /**

     * Returns the default DataIndexProvider name, given a data type. Data types are defined in {@link DataTypes}.

     * 

     * @param dataType, one of the constants in {@link DataTypes}. 

     * @return An instance of DataIndexProvider if there is anyone available for the given data type.

     */

    public String getDefaultFeatureIndexProviderName(int dataType);

}