|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DataManager
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 DataServerExplorer
(s), DataStore
(s),
Evaluator
(s) and FeatureIndex
(es).
ResourceManager
Method Summary | |
---|---|
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. |
FeatureAttributeGetter |
createFeatureAttributeGetter(String name)
Creates a FeatureAttributeGetter by name. |
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()
|
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 explorer,
String provider)
Creates, initializes and returns an instance of NewDataStoreParameters given the name with which their provider is registered. |
DataServerExplorer |
createServerExplorer(DataServerExplorerParameters parameters)
Deprecated. see openServerExplorer |
DataServerExplorerParameters |
createServerExplorerParameters(String name)
Returns an instance of DataServerExplorerParameters corresponding to
the given name. |
DataStore |
createStore(DataStoreParameters parameters)
Deprecated. see openStore |
DataStoreParameters |
createStoreParameters(String name)
Creates, initializes and returns an instance of DataStoreParameters given the name with which their provider is registered. |
List |
getDataTypes()
|
String |
getDefaultFeatureIndexProviderName(int dataType)
Returns the default DataIndexProvider name, given a data type. |
List |
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 |
getFeatureIndexProviders()
Returns a list of String containing the names of the available index providers. |
DataStoreProviderFactory |
getStoreProviderFactory(String name)
|
List |
getStoreProviders()
Returns a list of Strings containing the names of all available DataStore providers. |
List |
getStoreProviders(String name)
Returns a list of Strings containing the names of all available DataStore providers for an explorer. |
String |
getTemporaryDirectory()
Returns the default DAL's temporary directory |
void |
newStore(String explorer,
String provider,
NewDataStoreParameters parameters,
boolean overwrite)
Create a new physical store |
DataServerExplorer |
openServerExplorer(String name,
DataServerExplorerParameters parameters)
Returns an instance of DataServerExplorer given its parameters. |
DataStore |
openStore(String provider,
DataStoreParameters parameters)
Creates, initializes and returns an instance of DataStore given the DataStoreParameters. |
void |
registerDefaultEvaluator(Class evaluator)
Registers the default expression evaluator. |
void |
registerFeatureAttributeGetter(String name,
Class clazz)
Registers a class that can be used to create a FeatureAttributeGetter
and associate it to a FeatureAttributeDescriptor . |
void |
setDefaultFeatureIndexProviderName(int dataType,
String name)
Sets the default DataIndexProvider for the given data type. |
void |
setOpenErrorHandler(OpenErrorHandler handler)
|
Method Detail |
---|
String getTemporaryDirectory()
DataStoreParameters createStoreParameters(String name) throws InitializeException, ProviderNotRegisteredException
name
- provider name
ProviderNotRegisteredException
- if the memory provider is not registered
InitializeException
- if there is an error initializing the parameters for the
memory providerNewDataStoreParameters createNewStoreParameters(String explorer, String provider) throws InitializeException, ProviderNotRegisteredException
name
-
InitializeException
ProviderNotRegisteredException
DataStore openStore(String provider, DataStoreParameters parameters) throws InitializeException, ProviderNotRegisteredException, ValidateDataParametersException
parameters
- parameters used to instantiate and initialize the DataStore
ProviderNotRegisteredException
- if the memory provider is not registered
InitializeException
- if there is an error initializing the parameters for the
memory provider
ValidateDataParametersException
- if the parameters to open the memory based store are not
validDataStore createStore(DataStoreParameters parameters) throws InitializeException, ProviderNotRegisteredException, ValidateDataParametersException
InitializeException
ProviderNotRegisteredException
ValidateDataParametersException
void newStore(String explorer, String provider, NewDataStoreParameters parameters, boolean overwrite) throws InitializeException, ProviderNotRegisteredException, ValidateDataParametersException
parameters
-
InitializeException
ProviderNotRegisteredException
ValidateDataParametersException
List getStoreProviders()
List getStoreProviders(String name)
explorer
- nameDataServerExplorerParameters createServerExplorerParameters(String name) throws InitializeException, ProviderNotRegisteredException
DataServerExplorerParameters
corresponding to
the given name.
name
- name of a registered server explorer provider
InitializeException
- if parameter initialization causes an error.
ProviderNotRegisteredException
- if could not find a provider by the given name.DataServerExplorer openServerExplorer(String name, DataServerExplorerParameters parameters) throws InitializeException, ProviderNotRegisteredException, ValidateDataParametersException
DataServerExplorer
given its parameters.
parameters
- parameters used to instantiate and initialize the
DataServerExplorer
.
DataServerExplorer
.
InitializeException
ProviderNotRegisteredException
ValidateDataParametersException
DataServerExplorer createServerExplorer(DataServerExplorerParameters parameters) throws InitializeException, ProviderNotRegisteredException, ValidateDataParametersException
InitializeException
ProviderNotRegisteredException
ValidateDataParametersException
List getExplorerProviders()
void registerDefaultEvaluator(Class evaluator)
evaluator
- Class that will be called to evaluate the expression. It must
implement Evaluator
.Evaluator createExpresion(String expression) throws InitializeException
expression
- String containing a CQL expression.
InitializeException
List getFeatureIndexProviders()
void setDefaultFeatureIndexProviderName(int dataType, String name)
dataType
- one of the data types defined in DataTypes
.name
- Provider's nameString getDefaultFeatureIndexProviderName(int dataType)
DataTypes
.
dataType
- one of the constants in DataTypes
.
FeatureIndexProvider
if there is
anyone available for the given data type.List getFeatureCacheProviders()
DynObject createCacheParameters(String name) throws InitializeException, ProviderNotRegisteredException
DataServerExplorerParameters
corresponding
to the given name used by the cache to create a store to save the
retrieved data.
name
- name of a registered feature cache provider
InitializeException
- if parameter initialization causes an error.
ProviderNotRegisteredException
- if could not find a cache provider by the given name.DataStoreParameters createMemoryStoreParameters(String autoOrderAttributeName) throws InitializeException
DataStoreParameters
to create a
FeatureStore
based on the MemoryStoreProvider
.
autoOrderAttributeName
- the name of the Feature
attribute to be used to order
the store Feature
s by default. Set to null if you
don't want any order by default
InitializeException
- if there is an error initializing the parameters for the
memory providerFeatureStore createMemoryStore(String autoOrderAttributeName) throws InitializeException
FeatureStore
based on the
MemoryStoreProvider
.
autoOrderAttributeName
- the name of the Feature
attribute to be used to order
the store Feature
s by default. Set to null if you
don't want any order by default
InitializeException
- if there is an error initializing the parameters for the
memory providerFeaturePagingHelper createFeaturePagingHelper(FeatureStore featureStore, int pageSize) throws BaseException
FeaturePagingHelper
to paginate data from a
FeatureStore
.
featureStore
- to get the Feature
s frompageSize
- the page size
FeaturePagingHelper
BaseException
- if there is an error creating the helperFeaturePagingHelper createFeaturePagingHelper(FeatureStore featureStore, FeatureQuery featureQuery, int pageSize) throws BaseException
FeaturePagingHelper
to paginate data from a
FeatureStore
.
featureStore
- to get the Feature
s fromfeatureQuery
- to filter and/or order the datapageSize
- the page size
FeaturePagingHelper
BaseException
- if there is an error creating the helpervoid setOpenErrorHandler(OpenErrorHandler handler)
DataStoreProviderFactory getStoreProviderFactory(String name)
EditableFeatureType createFeatureType()
List getDataTypes()
void registerFeatureAttributeGetter(String name, Class clazz)
FeatureAttributeGetter
and associate it to a FeatureAttributeDescriptor
.
name
- the name used to register the class.clazz
- it has to be an instance of FeatureAttributeDescriptor
FeatureAttributeGetter createFeatureAttributeGetter(String name) throws InitializeException
FeatureAttributeGetter
by name. If there is not any class
registered with this name or if there is any error an exception is thrown.
name
- the name that was used to register the class
FeatureAttributeGetter
InitializeException
- if there is any error creating the object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |