/branches/v2_0_0_prep/libraries/libFMap_dal/src/org/gvsig/fmap/dal/DataManager.java - Diff - | gvSIG desktop 1 - gvSIG

Revision 32899 branches/v2_0_0_prep/libraries/libFMap_dal/src/org/gvsig/fmap/dal/DataManager.java

     import org.gvsig.fmap.dal.exception.InitializeException;
     import org.gvsig.fmap.dal.exception.ProviderNotRegisteredException;
     import org.gvsig.fmap.dal.exception.ValidateDataParametersException;
     import org.gvsig.fmap.dal.feature.Feature;
     import org.gvsig.fmap.dal.feature.FeatureIndex;
     import org.gvsig.fmap.dal.feature.FeatureStore;
     import org.gvsig.fmap.dal.feature.spi.index.FeatureIndexProvider;
     import org.gvsig.fmap.dal.resource.ResourceManager;
     import org.gvsig.fmap.dal.store.memory.MemoryStoreProvider;
     import org.gvsig.tools.dynobject.DynObject;
     import org.gvsig.tools.evaluator.Evaluator;
     /**
      * There are two top level management roles within DAL: data access and resource
      * management.
+     *
      * This class is responsible of the data access management role. It provides
      * ways for registering and instantiating {@link DataServerExplorer}(s),
      * {@link DataStore}(s), {@link Evaluator}(s) and {@link FeatureIndex}(es).
+     *
      * There are two top level management roles within DAL: data access and resource management.
+     *
      * This class is responsible of the data access management role. It provides ways
      * for registering and instantiating {@link DataServerExplorer}(s), {@link DataStore}(s),
      * {@link Evaluator}(s) and {@link FeatureIndex}(es).
+     *
      * @see ResourceManager
+     *
+     *
      */
     public interface DataManager {
     	/**
     	 * Returns the default DAL's temporary directory
+    	 *
+    	 *
     	 * @return Temporary directory name
     	 */
     	public String getTemporaryDirectory();
     	/*
     	 * ====================================================================
+    	 *
+    	 *
     	 * Store related services
     	 */
-...
     	 * @param name
     	 *            provider name
+    	 *
     	 * @throws ProviderNotRegisteredException
     	 *             if the memory provider is not registered
     	 * @throws InitializeException
+    	 *
     	 * @throws InitializeException
     	 * @throws ProviderNotRegisteredException
     	 *             if there is an error initializing the parameters for the
     	 *             memory provider
     	 **/
     	public DataStoreParameters createStoreParameters(String name)
     			throws InitializeException, ProviderNotRegisteredException;
     	/**
+    	 *
     	 * Creates, initializes and returns an instance of NewDataStoreParameters
     	 * given the name with which their provider is registered.
+    	 *
-...
     	 * Creates, initializes and returns an instance of DataStore given the
     	 * DataStoreParameters.
+    	 *
     	 * @param name of the provider
     	 * @param parameters
     	 *            parameters used to instantiate and initialize the DataStore
+    	 *
     	 * @throws ProviderNotRegisteredException
     	 *             if the memory provider is not registered
     	 * @throws InitializeException
+    	 *
     	 * @throws ProviderNotRegisteredException
     	 *             if there is an error initializing the parameters for the
     	 *             memory provider
     	 * @throws ValidateDataParametersException
     	 **/
     	 *             if the parameters to open the memory based store are not
     	 *             valid
     	 */
     	public DataStore openStore(String provider, DataStoreParameters parameters)
     			throws InitializeException, ProviderNotRegisteredException,
     			ValidateDataParametersException;
-...
     	/**
     	 * 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
     	 */
     	/**
     	 * Returns an instance of {@link DataServerExplorerParameters} corresponding
     	 * to the given name.
+    	 *
     	 * Returns an instance of {@link DataServerExplorerParameters} corresponding to
     	 * the given name.
+    	 *
     	 * @param name
     	 *            name of a registered server explorer provider
+    	 *
+    	 *
     	 * @throws InitializeException
     	 *             if parameter initialization causes an error.
+    	 *
     	 * 			if parameter initialization causes an error.
+    	 *
     	 * @throws ProviderNotRegisteredException
     	 *             if could not find a provider by the given name.
+    	 *
     	 * 			if could not find a provider by the given name.
+    	 *
     	 **/
     	public DataServerExplorerParameters createServerExplorerParameters(
     			String name) throws InitializeException,
     			ProviderNotRegisteredException;
     			String name)
     			throws InitializeException, ProviderNotRegisteredException;
     	/**
     	 * Returns an instance of {@link DataServerExplorer} given its parameters.
+    	 *
     	 * @param name of the explorer
+    	 *
     	 * @param parameters
     	 *            parameters used to instantiate and initialize the
     	 *            {@link DataServerExplorer}.
+    	 *
+    	 *
     	 * @return an instance of {@link DataServerExplorer}.
+    	 *
+    	 *
     	 * @throws InitializeException
+    	 *
+    	 *
     	 * @throws ProviderNotRegisteredException
     	 * @throws ValidateDataParametersException
     	 */
-...
     	/**
     	 * Returns a list of String containing the names of the available
     	 * DataServerExplorer providers.
+    	 *
+    	 *
     	 * @return list of String containing the names of the available
     	 *         DataServerExplorer providers.
     	 */
-...
     	/*
     	 * ====================================================================
+    	 *
+    	 *
     	 * 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}.
-...
     	/**
     	 * Creates an instance of Evaluator that represents the given expression.
+    	 *
+    	 *
     	 * @param expression
     	 *            String containing a CQL expression.
     	 * @return instance of Evaluator representing the given expression.
-...
     	/*
     	 * ====================================================================
+    	 *
+    	 *
     	 * 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
     	 * 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 {@link DataTypes}.
     	 * 				one of the data types defined in {@link DataTypes}.
     	 * @param name
     	 *            Provider's name
     	 * 			Provider's name
     	 */
     	public void setDefaultFeatureIndexProviderName(int dataType, String 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 the name of the default {@link FeatureIndexProvider} if there is
     	 *         anyone available for the given data type.
+    	 *
     	 * @return
     	 * 		the name of the default {@link FeatureIndexProvider} if there is
     	 * 		anyone available for the given data type.
     	 */
     	public String getDefaultFeatureIndexProviderName(int dataType);
         public String getDefaultFeatureIndexProviderName(int dataType);
         /**
     	 * Returns a list of String containing the names of the available cache providers.
+    	 *
     	 * @return
     	 * 		list of strings with the names of the available cache providers
     	 */
         public List getFeatureCacheProviders();
     	/**
     	 * Returns a list of String containing the names of the available cache
     	 * providers.
     	 * Returns an instance of {@link DataServerExplorerParameters} corresponding
     	 * to the given name used by the cache to create a store to save the
     	 * retrieved data.
+    	 *
     	 * @return list of strings with the names of the available cache providers
     	 */
     	public List getFeatureCacheProviders();
     	/**
     	 * Returns an instance of {@link DataServerExplorerParameters} corresponding to
     	 * the given name used by the cache to create a store to save the retrieved data.
+    	 *
     	 * @param name
     	 *            name of a registered feature cache provider
+    	 *
+    	 *
     	 * @throws InitializeException
     	 * 			if parameter initialization causes an error.
+    	 *
     	 *             if parameter initialization causes an error.
+    	 *
     	 * @throws ProviderNotRegisteredException
     	 * 			if could not find a cache provider by the given name.
+    	 *
     	 **/
         public DynObject createCacheParameters(String name) throws InitializeException,
         	ProviderNotRegisteredException;
     	 *             if could not find a cache provider by the given name.
+    	 *
     	 */
     	public DynObject createCacheParameters(String name)
     			throws InitializeException, ProviderNotRegisteredException;
     	/**
     	 * Utility method to create the {@link DataStoreParameters} to create a
     	 * {@link FeatureStore} based on the {@link MemoryStoreProvider}.
+    	 *
     	 * @param autoOrderAttributeName
     	 *            the name of the {@link Feature} attribute to be used to order
     	 *            the store {@link Feature}s by default. Set to null if you
     	 *            don't want any order by default
     	 * @return the parameters for the memory based store
     	 * @throws InitializeException
     	 *             if there is an error initializing the parameters for the
     	 *             memory provider
     	 */
     	public DataStoreParameters createMemoryStoreParameters(
     			String autoOrderAttributeName) throws InitializeException;
     	/**
     	 * Utility method to create the a {@link FeatureStore} based on the
     	 * {@link MemoryStoreProvider}.
+    	 *
     	 * @param autoOrderAttributeName
     	 *            the name of the {@link Feature} attribute to be used to order
     	 *            the store {@link Feature}s by default. Set to null if you
     	 *            don't want any order by default
     	 * @return the the memory based store
     	 * @throws InitializeException
     	 *             if there is an error initializing the parameters for the
     	 *             memory provider
     	 */
     	public FeatureStore createMemoryStore(String autoOrderAttributeName)
     			throws InitializeException;
+    }

Also available in: Unified diff