Application: gvSIG desktop

package org.gvsig.fmap.data;

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

import org.gvsig.fmap.data.exceptions.NotResgisteredStore;

import org.gvsig.fmap.data.feature.FeatureAttributeDescriptor;

import org.gvsig.fmap.data.feature.FeatureStore;

import org.gvsig.fmap.data.feature.FeatureType;

import org.gvsig.fmap.data.feature.spi.DataIndexProvider;

import org.gvsig.tools.evaluator.Evaluator;

import org.gvsig.tools.operations.Operation;

import com.iver.utiles.XMLEntity;

public interface DataManager {

        /**

         *

         * @param String

         *            name

         * @param Class

         *            dataStoreClass

         * @param Class

         *            parametersClass

         */

        public void registerDefaultEvaluator(Class evaluator);

        public Evaluator createExpresion(String expresion);

        public void registerDataStoreProvider(String name, Class dataStoreProviderClass,

                        Class parametersClass);

        /**

         * Levanta una instancia de los parametros solicitados inicializa el nombre

         * en la instancia y la devuelve.

         *

         * @throws InitializeException

         *             TODO

         **/

        /**

         * Start a instance of the solicited parameters inicialize the instance name

         * and returns it.

         *

         * @param String

         *            name

         * @throws InitializeException

         *             TODO

         * @throws NotResgisteredStore

         **/

        public DataStoreParameters createDataStoreParameters(String name)

                        throws InitializeException, NotResgisteredStore;

        public DataStoreParameters createDataStoreParameters(

                        XMLEntity xmlEntity)

                        throws InitializeException, NotResgisteredStore;

        /**

         * Levanta la instancia del datasource,

         * levanta una instancia del driver que precisa el datasource

         * y por ultimo invoca al metodo init del datasource.

         * @throws InitializeException

         **/

        /**

         * Start a instance of datasource, start a instance of driver that

         * datasource needs at ends invoke datasource init method

         *

         * @params DataStoreParameters parameters

         * @throws InitializeException

         * @throws NotResgisteredStore

         **/

        public DataStore createDataStore(DataStoreParameters parameters)

                        throws InitializeException, NotResgisteredStore;

        public DataStore createDataStore(XMLEntity xmlEntity)

                        throws InitializeException, NotResgisteredStore;

        /**

         * Collection of generic properties of a DataStore type which can access

         * without create a DataStore/Driver.

         *

         * For example for "DriverDataSource.shp" could have the size of the data

         * identification.

         *

         * In "DriverDataSource.postgres" could add information about availables

         * tables or things like that. We`ll have to see what GeoDB needs and where

         * it can get.

         *

         * We have to think it good.

         */

        /**

         * @param String name

         * @param Class dataSourceClass

         * @param Class parametersClass

         */

        public void registerDataExplorer(String name,

                        Class dataSourceClass, Class parametersClass);

        /**

         * Levanta una instancia de los parametros solicitados

         * inicializa el nombre en la instancia

         * y la devuelve.

         * @throws InitializeException TODO

         **/

        /**

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

         * and returns it.

         *

         * @param String

         *            name

         * @throws InitializeException

         *             TODO

         * @throws NotResgisteredStore

         **/

        public DataExplorerParameters createDataExplorerParameters(

                        String name)

                        throws InitializeException, NotResgisteredStore;

        /**

         *

         * @param DataExplorerParameters

         *            parameters

         * @return DataExplorer

         * @throws InitializeException

         * @throws NotResgisteredStore

         */

        public DataExplorerParameters createDataExplorerParameters(

                        XMLEntity xmlEntity) throws InitializeException,

                        NotResgisteredStore;

        public DataExplorer createDataExplorer(

                        DataExplorerParameters parameters)

                        throws InitializeException, NotResgisteredStore;

        /**

         * 

         * @param String

         *            name

         * @return RegisterInfo

         * @throws NotResgisteredStore

         */

        public DataExplorer createDataExplorer(XMLEntity xmlEntity)

                        throws InitializeException, NotResgisteredStore;

        /**

         *

         * @param String

         *            storeName

         * @param String

         *            operationName

         * @param DataStoreOperation

         *            operation

         * @return int index

         * @throws IllegalArgumentException

         */

        public int registerDataStoreOperation(String storeName,

                        String operationName, Operation operation);

        /**

         *

         * @return String[] TYPE_STORE

         */

        public String[] getRegistersStores();

        /**

         *

         * @return String[] TYPE_EXPLORER

         */

        public String[] getRegistersExplorers();

        /**

         * Returns an array of index provider names that are compatible with

         * the given data type.

         * 

         * @param dataType

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

         */

        public String[] getDataIndexProviders(int dataType);

        /**

         * Registers a new DataIndexProvider

         * @param name identifier

         * @param description a brief description of the provider

         * @param clazz implementation class

         */

        public void registerDataIndexProvider(String name, String description, Class clazz);

        /**

         * Returns a DataIndexProvider compatible with the attribute data type.

         * @param store associated FeatureStore

         * @param type associated FeatureType 

         * @param attr associated FeatureAttributeDescriptor

         * @param providerNames array of strings containing one or more preferred providers

         * @return empty DataIndexProvider, initialized and ready to use

         */

        public DataIndexProvider createDataIndexProvider(FeatureStore store, FeatureType type, 

                        FeatureAttributeDescriptor attr, String[] providerNames) throws InitializeException, NotResgisteredStore;

        /**

         * Returns the default DataIndexProvider compatible with the attribute data type.

         * @param store associated FeatureStore

         * @param type associated FeatureType 

         * @param attr associated FeatureAttributeDescriptor

         * @return

         */

        public DataIndexProvider createDataIndexProvider(FeatureStore store, FeatureType type,

                        FeatureAttributeDescriptor attr) throws InitializeException, NotResgisteredStore;

        /**

         * 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 setDefaultDataIndexProviderName(int dataType, String name);

    /**

     * Returns the default DataIndexProvider name, given a data type.

     * @param dataType

     * @return

     */

    public String getDefaultDataIndexProviderName(int dataType);

    /**

     * Returns the default DAL's temporary directory

     * @return Temporary directory name

     */

    public String getTemporaryDirectory();        

}