org.gvsig.fmap.dal.impl

Class DefaultDataManager

java.lang.Object

org.gvsig.fmap.dal.impl.DefaultDataManager

All Implemented Interfaces:

DataManager, DataManagerProviderServices, Services

public class DefaultDataManager
extends Object
implements DataManager, DataManagerProviderServices, Services

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILESYSTEM_EXPLORER_NAME

Fields inherited from interface org.gvsig.fmap.dal.DataManager

CREATE_STORE_AUTHORIZATION, READ_STORE_AUTHORIZATION, WRITE_STORE_AUTHORIZATION

Constructor Summary

Constructors

Constructor and Description
DefaultDataManager()

Method Summary

Modifier and Type	Method and Description
DynObject	createCacheParameters(String name) Returns an instance of DataServerExplorerParameters corresponding to the given name used by the cache to create a store to save the retrieved data.
Evaluator	createExpresion(String expression) Creates an instance of Evaluator that represents the given expression.
ExpressionBuilder	createExpressionBuilder() Creates a default ExpressionBuilder.
FeatureCacheProvider	createFeatureCacheProvider(String name, DynObject parameters)
FeatureIndexProviderServices	createFeatureIndexProvider(String name, FeatureStore store, FeatureType type, String indexName, FeatureAttributeDescriptor attr) Returns a DataIndexProvider compatible with the attribute data type.
FeaturePagingHelper	createFeaturePagingHelper(FeatureStore featureStore, FeatureQuery featureQuery, int pageSize) Creates a FeaturePagingHelper to paginate data from a FeatureStore.
FeaturePagingHelper	createFeaturePagingHelper(FeatureStore featureStore, int pageSize) Creates a FeaturePagingHelper to paginate data from a FeatureStore.
EditableFeatureType	createFeatureType()
void	createFileStore(String providerName, NewDataStoreParameters params, boolean overwrite)
FeatureStore	createMemoryStore(String autoOrderAttributeName) Utility method to create the a FeatureStore based on the MemoryStoreProvider.
DataStoreParameters	createMemoryStoreParameters(String autoOrderAttributeName) Utility method to create the DataStoreParameters to create a FeatureStore based on the MemoryStoreProvider.
NewDataStoreParameters	createNewStoreParameters(String explorerName, String providerName) Creates, initializes and returns an instance of NewDataStoreParameters given the name with which their provider is registered.
DataStoreProvider	createProvider(DataStoreProviderServices providerServices, DataStoreParameters parameters) Creates a new instance of the provider associated to the passed parameters.
DataServerExplorer	createServerExplorer(DataServerExplorerParameters parameters) Deprecated. see openServerExplorer
DataServerExplorerParameters	createServerExplorerParameters(String explorerName) Returns an instance of DataServerExplorerParameters corresponding to the given name.
DataStore	createStore(DataStoreParameters parameters) Deprecated. use openStore
DataStoreParameters	createStoreParameters(DynStruct struct) Creates, initializes and fill an instance of DataStoreParameters from the tags of the DynStruct passed as parameter.
DataStoreParameters	createStoreParameters(String providerName) Creates, initializes and returns an instance of DataStoreParameters given the name with which their provider is registered.
DataStoreParameters	createStoreParameters(Tags tags)
DataServerExplorerPool	getDataServerExplorerPool()
List<DataType>	getDataTypes() Return a list of the DataTypes supported for the type of the feature attributes.
String	getDefaultFeatureIndexProviderName(int dataType) Returns the default DataIndexProvider name, given a data type.
List<String>	getExplorerProviders() Returns a list of String containing the names of the available DataServerExplorer providers.
List	getFeatureCacheProviders() Returns a list of String containing the names of the available cache providers.
List<String>	getFeatureIndexProviders() Returns a list of String containing the names of the available index providers.
Register	getFeatureIndexRegister()
OpenErrorHandler	getOpenErrorHandler()
URL	getResource(Object reourceLoader, String name) Return the URL associated to the indicated resource.
InputStream	getResourceAsStream(Object reourceLoader, String name) Return the InputStream associated to the indicated resource.
Register	getServerExplorerRegister()
DataStoreProviderFactory	getStoreProviderFactory(String providerName)
Register	getStoreProviderRegister()
List<String>	getStoreProviders() Returns a list of Strings containing the names of all available DataStore providers.
List<String>	getStoreProviders(String explorerName) Returns a list of Strings containing the names of all available DataStore providers for an explorer.
Register	getStoreRegister()
String	getTemporaryDirectory() Returns the default DAL's temporary directory
void	newStore(String explorerName, String providerName, NewDataStoreParameters parameters, boolean overwrite) Create a new physical store
DataServerExplorer	openServerExplorer(String explorerName, DataServerExplorerParameters parameters) Returns an instance of DataServerExplorer given its parameters.
DataServerExplorer	openServerExplorer(String explorerName, Object... arguments)
DataStore	openStore(DynStruct struct)
DataStore	openStore(String providerName, DataStoreParameters parameters)
DataStore	openStore(String provider, DynObject parameters) Creates, initializes and returns an instance of DataStore given the DataStoreParameters.
DataStore	openStore(String providerName, Object... arguments)
void	registerDefaultEvaluator(EvaluatorFactory evaluatorFactory) Registers the default expression evaluator.
void	registerDefaultRasterStore(Class rasterStoreClass) Deprecated.
void	registerExplorerProvider(String name, Class explorerClass, Class parametersClass)
void	registerFeatureCacheProvider(FeatureCacheProviderFactory providerFactory)
void	registerServerExplorerFactory(DataServerExplorerFactory factory)
void	registerStoreFactory(DataStoreFactory_v2_4 factory)
void	registerStoreFactory(String name, Class storeFactoryClass) Deprecated.
void	registerStoreProvider(String name, Class storeProviderClass, Class parametersClass) Deprecated. use registerStoreProviderFactory
void	registerStoreProviderFactory(DataStoreProviderFactory factory)
void	setDataServerExplorerPool(DataServerExplorerPool pool)
void	setDefaultFeatureIndexProviderName(int dataType, String name) Sets the default DataIndexProvider for the given data type.
void	setOpenErrorHandler(OpenErrorHandler handler)
void	setResourcesLoader(ClassLoader loader)
void	setResourcesLoader(File folder)
DataStoreParameters	toDataStoreParameters(String provider, DynObject params)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FILESYSTEM_EXPLORER_NAME

public static final String FILESYSTEM_EXPLORER_NAME

See Also:

Constant Field Values

Constructor Detail

DefaultDataManager

public DefaultDataManager()

Method Detail

getStoreRegister

public Register getStoreRegister()

Specified by:

getStoreRegister in interface DataManager

getStoreProviderRegister

public Register getStoreProviderRegister()

Specified by:

getStoreProviderRegister in interface DataManager

getServerExplorerRegister

public Register getServerExplorerRegister()

Specified by:

getServerExplorerRegister in interface DataManager

getFeatureIndexRegister

public Register getFeatureIndexRegister()

Specified by:

getFeatureIndexRegister in interface DataManager

registerDefaultRasterStore

public void registerDefaultRasterStore(Class rasterStoreClass)

Deprecated.

Description copied from interface: DataManagerProviderServices

Este metodo es temporal hasta que se integre el nuevo raster en el core de gvSIG.

Specified by:

registerDefaultRasterStore in interface DataManagerProviderServices

registerStoreFactory

public void registerStoreFactory(String name,
                                 Class storeFactoryClass)

Deprecated.

Description copied from interface: DataManagerProviderServices

Registers a store factory.

Specified by:

registerStoreFactory in interface DataManagerProviderServices

registerStoreProvider

public void registerStoreProvider(String name,
                                  Class storeProviderClass,
                                  Class parametersClass)

Deprecated. use registerStoreProviderFactory

Description copied from interface: DataManagerProviderServices

Registers a store .

Specified by:

registerStoreProvider in interface DataManagerProviderServices

Parameters:

name -

storeProviderClass -

parametersClass -

registerExplorerProvider

public void registerExplorerProvider(String name,
                                     Class explorerClass,
                                     Class parametersClass)

Specified by:

registerExplorerProvider in interface DataManagerProviderServices

explorerClass - class of provider

parametersClass - parameters class of provider

registerStoreFactory

public void registerStoreFactory(DataStoreFactory_v2_4 factory)

Specified by:

registerStoreFactory in interface DataManagerProviderServices

registerStoreProviderFactory

public void registerStoreProviderFactory(DataStoreProviderFactory factory)

Specified by:

registerStoreProviderFactory in interface DataManagerProviderServices

registerServerExplorerFactory

public void registerServerExplorerFactory(DataServerExplorerFactory factory)

Specified by:

registerServerExplorerFactory in interface DataManagerProviderServices

createStoreParameters

public DataStoreParameters createStoreParameters(String providerName)
                                          throws InitializeException,
                                                 ProviderNotRegisteredException

Description copied from interface: DataManager

Creates, initializes and returns an instance of DataStoreParameters given the name with which their provider is registered.

Specified by:

createStoreParameters in interface DataManager

Parameters:

providerName - provider name

Returns:

the data store parameters

Throws:

InitializeException - if there is an error initializing the parameters for the memory provider

ProviderNotRegisteredException - if the memory provider is not registered

createNewStoreParameters

public NewDataStoreParameters createNewStoreParameters(String explorerName,
                                                       String providerName)
                                                throws InitializeException,
                                                       ProviderNotRegisteredException

Description copied from interface: DataManager

Creates, initializes and returns an instance of NewDataStoreParameters given the name with which their provider is registered.

Specified by:

createNewStoreParameters in interface DataManager

Returns:

Throws:

InitializeException

ProviderNotRegisteredException

createServerExplorerParameters

public DataServerExplorerParameters createServerExplorerParameters(String explorerName)
                                                            throws InitializeException,
                                                                   ProviderNotRegisteredException

Description copied from interface: DataManager

Returns an instance of DataServerExplorerParameters corresponding to the given name.

Specified by:

createServerExplorerParameters in interface DataManager

Parameters:

explorerName - name of a registered server explorer provider

Returns:

Throws:

InitializeException - if parameter initialization causes an error.

ProviderNotRegisteredException - if could not find a provider by the given name.

createMemoryStoreParameters

public DataStoreParameters createMemoryStoreParameters(String autoOrderAttributeName)
                                                throws InitializeException

Description copied from interface: DataManager

Utility method to create the DataStoreParameters to create a FeatureStore based on the MemoryStoreProvider.

Specified by:

createMemoryStoreParameters in interface DataManager

Parameters:

autoOrderAttributeName - the name of the Feature attribute to be used to order the store Features by default. Set to null if you don't want any order by default

Returns:

the parameters for the memory based store

Throws:

InitializeException - if there is an error initializing the parameters for the memory provider

openServerExplorer

public DataServerExplorer openServerExplorer(String explorerName,
                                             DataServerExplorerParameters parameters)
                                      throws InitializeException,
                                             ProviderNotRegisteredException,
                                             ValidateDataParametersException

Description copied from interface: DataManager

Returns an instance of DataServerExplorer given its parameters.

Specified by:

openServerExplorer in interface DataManager

parameters - parameters used to instantiate and initialize the DataServerExplorer.

Returns:

an instance of DataServerExplorer.

Throws:

InitializeException

ProviderNotRegisteredException

ValidateDataParametersException

openServerExplorer

public DataServerExplorer openServerExplorer(String explorerName,
                                             Object... arguments)
                                      throws InitializeException,
                                             ProviderNotRegisteredException,
                                             ValidateDataParametersException

Specified by:

openServerExplorer in interface DataManager

Throws:

InitializeException

ProviderNotRegisteredException

ValidateDataParametersException

createServerExplorer

public DataServerExplorer createServerExplorer(DataServerExplorerParameters parameters)
                                        throws InitializeException,
                                               ProviderNotRegisteredException,
                                               ValidateDataParametersException

Deprecated. see openServerExplorer

Specified by:

createServerExplorer in interface DataManager

Parameters:

parameters -

Returns:

Throws:

InitializeException

ProviderNotRegisteredException

ValidateDataParametersException

createStore

public DataStore createStore(DataStoreParameters parameters)
                      throws InitializeException,
                             ProviderNotRegisteredException,
                             ValidateDataParametersException

Deprecated. use openStore

Specified by:

createStore in interface DataManager

Parameters:

parameters -

Returns:

Throws:

InitializeException

ProviderNotRegisteredException

ValidateDataParametersException

openStore

public DataStore openStore(String providerName,
                           DataStoreParameters parameters)
                    throws InitializeException,
                           ProviderNotRegisteredException,
                           ValidateDataParametersException

Specified by:

openStore in interface DataManager

Throws:

InitializeException

ProviderNotRegisteredException

ValidateDataParametersException

openStore

public DataStore openStore(String provider,
                           DynObject parameters)
                    throws InitializeException,
                           ProviderNotRegisteredException,
                           ValidateDataParametersException

Description copied from interface: DataManager

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

Specified by:

openStore in interface DataManager

parameters - parameters used to instantiate and initialize the DataStore

Returns:

Throws:

InitializeException - if there is an error initializing the parameters for the memory provider

ProviderNotRegisteredException - if the memory provider is not registered

ValidateDataParametersException - if the parameters to open the memory based store are not valid

openStore

public DataStore openStore(String providerName,
                           Object... arguments)
                    throws InitializeException,
                           ProviderNotRegisteredException,
                           ValidateDataParametersException

Specified by:

openStore in interface DataManager

Throws:

InitializeException

ProviderNotRegisteredException

ValidateDataParametersException

createMemoryStore

public FeatureStore createMemoryStore(String autoOrderAttributeName)
                               throws InitializeException

Description copied from interface: DataManager

Utility method to create the a FeatureStore based on the MemoryStoreProvider.

Specified by:

createMemoryStore in interface DataManager

Parameters:

autoOrderAttributeName - the name of the Feature attribute to be used to order the store Features by default. Set to null if you don't want any order by default

Returns:

the the memory based store

Throws:

InitializeException - if there is an error initializing the parameters for the memory provider

getStoreProviderFactory

public DataStoreProviderFactory getStoreProviderFactory(String providerName)

Specified by:

getStoreProviderFactory in interface DataManager

getStoreProviders

public List<String> getStoreProviders()

Description copied from interface: DataManager

Returns a list of Strings containing the names of all available DataStore providers.

Specified by:

getStoreProviders in interface DataManager

Returns:

list of String containing available DataStore provider names

getStoreProviders

public List<String> getStoreProviders(String explorerName)

Description copied from interface: DataManager

Returns a list of Strings containing the names of all available DataStore providers for an explorer.

Specified by:

getStoreProviders in interface DataManager

Returns:

getExplorerProviders

public List<String> getExplorerProviders()

Description copied from interface: DataManager

Returns a list of String containing the names of the available DataServerExplorer providers.

Specified by:

getExplorerProviders in interface DataManager

Returns:

list of String containing the names of the available DataServerExplorer providers.

createProvider

public DataStoreProvider createProvider(DataStoreProviderServices providerServices,
                                        DataStoreParameters parameters)
                                 throws InitializeException,
                                        ProviderNotRegisteredException

Description copied from interface: DataManagerProviderServices

Creates a new instance of the provider associated to the passed parameters.

Specified by:

createProvider in interface DataManagerProviderServices

Returns:

Throws:

InitializeException

ProviderNotRegisteredException

getFeatureIndexProviders

public List<String> getFeatureIndexProviders()

Description copied from interface: DataManager

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

Specified by:

getFeatureIndexProviders in interface DataManager

Returns:

list of strings with the names of the available index providers

setDefaultFeatureIndexProviderName

public void setDefaultFeatureIndexProviderName(int dataType,
                                               String name)

Description copied from interface: DataManager

Sets the default DataIndexProvider for the given data type.

Specified by:

setDefaultFeatureIndexProviderName in interface DataManager

Parameters:

dataType - one of the data types defined in DataTypes.

name - Provider's name

getDefaultFeatureIndexProviderName

public String getDefaultFeatureIndexProviderName(int dataType)

Description copied from interface: DataManager

Returns the default DataIndexProvider name, given a data type. Data types are defined in DataTypes.

Specified by:

getDefaultFeatureIndexProviderName in interface DataManager

Parameters:

dataType - one of the constants in DataTypes.

Returns:

the name of the default FeatureIndexProvider if there is anyone available for the given data type.

createFeatureIndexProvider

public FeatureIndexProviderServices createFeatureIndexProvider(String name,
                                                               FeatureStore store,
                                                               FeatureType type,
                                                               String indexName,
                                                               FeatureAttributeDescriptor attr)
                                                        throws InitializeException,
                                                               ProviderNotRegisteredException

Description copied from interface: DataManagerProviderServices

Returns a DataIndexProvider compatible with the attribute data type.

Specified by:

createFeatureIndexProvider in interface DataManagerProviderServices

store - associated FeatureStore

type - associated FeatureType

attr - associated FeatureAttributeDescriptor

Returns:

empty DataIndexProvider, initialized and ready to use

Throws:

InitializeException

ProviderNotRegisteredException

getTemporaryDirectory

public String getTemporaryDirectory()

Description copied from interface: DataManager

Returns the default DAL's temporary directory

Specified by:

getTemporaryDirectory in interface DataManager

Returns:

Temporary directory name

createStoreParameters

public DataStoreParameters createStoreParameters(DynStruct struct)
                                          throws InitializeException,
                                                 ProviderNotRegisteredException

Description copied from interface: DataManager

Creates, initializes and fill an instance of DataStoreParameters from the tags of the DynStruct passed as parameter.

Specified by:

createStoreParameters in interface DataManager

Parameters:

struct - structure from which tags were created ths parameters.

Returns:

the data store parameters

Throws:

InitializeException - if there is an error initializing the parameters for the memory provider

ProviderNotRegisteredException - if the memory provider is not registered

createStoreParameters

public DataStoreParameters createStoreParameters(Tags tags)
                                          throws InitializeException,
                                                 ProviderNotRegisteredException

Specified by:

createStoreParameters in interface DataManager

Throws:

InitializeException

ProviderNotRegisteredException

openStore

public DataStore openStore(DynStruct struct)
                    throws InitializeException,
                           ProviderNotRegisteredException,
                           ValidateDataParametersException

Specified by:

openStore in interface DataManager

Throws:

InitializeException

ProviderNotRegisteredException

ValidateDataParametersException

newStore

public void newStore(String explorerName,
                     String providerName,
                     NewDataStoreParameters parameters,
                     boolean overwrite)
              throws InitializeException,
                     ProviderNotRegisteredException,
                     ValidateDataParametersException

Description copied from interface: DataManager

Create a new physical store

Specified by:

newStore in interface DataManager

Throws:

InitializeException

ProviderNotRegisteredException

ValidateDataParametersException

registerDefaultEvaluator

public void registerDefaultEvaluator(EvaluatorFactory evaluatorFactory)

Description copied from interface: DataManager

Registers the default expression evaluator. It is used by DAL to evaluate and resolve query filters and expressions.

Specified by:

registerDefaultEvaluator in interface DataManager

createExpresion

public Evaluator createExpresion(String expression)
                          throws InitializeException

Description copied from interface: DataManager

Creates an instance of Evaluator that represents the given expression.

Specified by:

createExpresion in interface DataManager

Parameters:

expression - String containing a CQL expression.

Returns:

instance of Evaluator representing the given expression.

Throws:

InitializeException

createFeaturePagingHelper

public FeaturePagingHelper createFeaturePagingHelper(FeatureStore featureStore,
                                                     int pageSize)
                                              throws BaseException

Description copied from interface: DataManager

Creates a FeaturePagingHelper to paginate data from a FeatureStore.

Specified by:

createFeaturePagingHelper in interface DataManager

Parameters:

featureStore - to get the Features from

pageSize - the page size

Returns:

a FeaturePagingHelper

Throws:

BaseException - if there is an error creating the helper

createFeaturePagingHelper

public FeaturePagingHelper createFeaturePagingHelper(FeatureStore featureStore,
                                                     FeatureQuery featureQuery,
                                                     int pageSize)
                                              throws BaseException

Description copied from interface: DataManager

Creates a FeaturePagingHelper to paginate data from a FeatureStore.

Specified by:

createFeaturePagingHelper in interface DataManager

Parameters:

featureStore - to get the Features from

featureQuery - to filter and/or order the data

pageSize - the page size

Returns:

a FeaturePagingHelper

Throws:

BaseException - if there is an error creating the helper

setOpenErrorHandler

public void setOpenErrorHandler(OpenErrorHandler handler)

Specified by:

setOpenErrorHandler in interface DataManager

getOpenErrorHandler

public OpenErrorHandler getOpenErrorHandler()

Specified by:

getOpenErrorHandler in interface DataManager

createFeatureType

public EditableFeatureType createFeatureType()

Specified by:

createFeatureType in interface DataManager

getDataServerExplorerPool

public DataServerExplorerPool getDataServerExplorerPool()

Specified by:

getDataServerExplorerPool in interface DataManager

setDataServerExplorerPool

public void setDataServerExplorerPool(DataServerExplorerPool pool)

Specified by:

setDataServerExplorerPool in interface DataManager

toDataStoreParameters

public DataStoreParameters toDataStoreParameters(String provider,
                                                 DynObject params)
                                          throws InitializeException,
                                                 ProviderNotRegisteredException

Throws:

InitializeException

ProviderNotRegisteredException

getDataTypes

public List<DataType> getDataTypes()

Description copied from interface: DataManager

Return a list of the DataTypes supported for the type of the feature attributes. The list is only informative.

Specified by:

getDataTypes in interface DataManager

Returns:

setResourcesLoader

public void setResourcesLoader(ClassLoader loader)

Specified by:

setResourcesLoader in interface DataManager

setResourcesLoader

public void setResourcesLoader(File folder)

Specified by:

setResourcesLoader in interface DataManager

getResource

public URL getResource(Object reourceLoader,
                       String name)

Description copied from interface: DataManagerProviderServices

Return the URL associated to the indicated resource. If the data manager has set a resource loader, use this to search the resource. If this don't contain the indicated resource or the data manager has not set a resource loader, search the resource in the class loader of the object "resourceLoader" indicated as parameter. This is usefull to load the resource files associateds to the xml of parameter and metadad description.

Specified by:

getResource in interface DataManagerProviderServices

Returns:

getResourceAsStream

public InputStream getResourceAsStream(Object reourceLoader,
                                       String name)

Description copied from interface: DataManagerProviderServices

Return the InputStream associated to the indicated resource. If the data manager has set a resource loader, use this to search the resource. If this don't contain the indicated resource or the data manager has not set a resource loader, search the resource in the class loader of the object "resourceLoader" indicated as parameter. This is usefull to load the resource files associateds to the xml of parameter and metadad description.

Specified by:

getResourceAsStream in interface DataManagerProviderServices

Returns:

createExpressionBuilder

public ExpressionBuilder createExpressionBuilder()

Description copied from interface: DataManager

Creates a default ExpressionBuilder. This ExpressionBuilder is not dependent on a data source, and is not advisable to use it.

Specified by:

createExpressionBuilder in interface DataManager

Returns:

the ExpressionBuilder

registerFeatureCacheProvider

public void registerFeatureCacheProvider(FeatureCacheProviderFactory providerFactory)

createFeatureCacheProvider

public FeatureCacheProvider createFeatureCacheProvider(String name,
                                                       DynObject parameters)
                                                throws DataException

Throws:

DataException

getFeatureCacheProviders

public List getFeatureCacheProviders()

Description copied from interface: DataManager

Returns a list of String containing the names of the available cache providers.

Specified by:

getFeatureCacheProviders in interface DataManager

Returns:

list of strings with the names of the available cache providers

createCacheParameters

public DynObject createCacheParameters(String name)
                                throws InitializeException,
                                       ProviderNotRegisteredException

Description copied from interface: DataManager

Returns an instance of DataServerExplorerParameters corresponding to the given name used by the cache to create a store to save the retrieved data.

Specified by:

createCacheParameters in interface DataManager

Parameters:

name - name of a registered feature cache provider

Returns:

Throws:

InitializeException - if parameter initialization causes an error.

ProviderNotRegisteredException - if could not find a cache provider by the given name.

createFileStore

public void createFileStore(String providerName,
                            NewDataStoreParameters params,
                            boolean overwrite)
                     throws DataException

Specified by:

createFileStore in interface DataManager

Throws:

DataException