Revision 24388 branches/v2_0_0_prep/libraries/libFMap_data/src/org/gvsig/fmap/data/DataManager.java
| DataManager.java | ||
|---|---|---|
| 8 | 8 |
import org.gvsig.tools.evaluator.Evaluator; |
| 9 | 9 |
|
| 10 | 10 |
/** |
| 11 |
* This class contains all DAL specific services (note that resource management is {@link ResourceManager}'s responsibility)
|
|
| 12 |
* are not related to resources. |
|
| 11 |
* This class contains the main DAL specific services. It provides functionality for |
|
| 12 |
* registering and instantiating DataExplorer(s), DataStore(s), Evaluator(s) and FeatureIndex(es). |
|
| 13 |
* |
|
| 14 |
* (note that resource management is {@link ResourceManager}'s responsibility)
|
|
| 13 | 15 |
* |
| 14 | 16 |
*/ |
| 17 |
|
|
| 15 | 18 |
public interface DataManager {
|
| 16 | 19 |
|
| 17 | 20 |
/** |
| ... | ... | |
| 28 | 31 |
*/ |
| 29 | 32 |
|
| 30 | 33 |
/** |
| 31 |
* Creates, initializes and returns an instance of the solicited parameters given the name with which they are registered. |
|
| 34 |
* Creates, initializes and returns an instance of DataStoreParameters given the name with which |
|
| 35 |
* their provider is registered. |
|
| 32 | 36 |
* |
| 33 | 37 |
* @param String |
| 34 |
* name with which the parameters type were registered
|
|
| 38 |
* provider name
|
|
| 35 | 39 |
* @throws InitializeException |
| 36 |
* TODO
|
|
| 40 |
* |
|
| 37 | 41 |
* @throws ProviderNotRegisteredException |
| 38 | 42 |
**/ |
| 39 | 43 |
public DataStoreParameters createStoreParameters(String name) |
| 40 | 44 |
throws InitializeException, ProviderNotRegisteredException; |
| 41 | 45 |
|
| 42 | 46 |
/** |
| 43 |
* Start a instance of data store, start a instance of provider that data
|
|
| 44 |
* store needs at ends initialize the data store.
|
|
| 47 |
* |
|
| 48 |
* Creates, initializes and returns an instance of DataStore given the DataStoreParameters.
|
|
| 45 | 49 |
* |
| 46 |
* @params DataStoreParameters parameters |
|
| 50 |
* @param DataStoreParameters |
|
| 51 |
* parameters used to instantiate and initialize the DataStore |
|
| 47 | 52 |
* @throws InitializeException |
| 53 |
* |
|
| 48 | 54 |
* @throws ProviderNotRegisteredException |
| 49 | 55 |
**/ |
| 50 | 56 |
public DataStore createStore(DataStoreParameters parameters) |
| 51 | 57 |
throws InitializeException, ProviderNotRegisteredException; |
| 52 | 58 |
|
| 53 | 59 |
|
| 60 |
/** |
|
| 61 |
* Returns a list of Strings containing the names of all available |
|
| 62 |
* DataStore providers. |
|
| 63 |
* |
|
| 64 |
* @return list of String containing available DataStore provider names |
|
| 65 |
*/ |
|
| 54 | 66 |
public List getStoreProviders(); |
| 55 | 67 |
|
| 56 | 68 |
/* |
| ... | ... | |
| 67 | 79 |
* @throws InitializeException |
| 68 | 80 |
* @throws ProviderNotRegisteredException |
| 69 | 81 |
**/ |
| 70 |
|
|
| 71 | 82 |
public DataExplorerParameters createExplorerParameters( |
| 72 | 83 |
String name) |
| 73 | 84 |
throws InitializeException, ProviderNotRegisteredException; |
| 74 | 85 |
|
| 86 |
/** |
|
| 87 |
* |
|
| 88 |
* @param parameters |
|
| 89 |
* @return |
|
| 90 |
* @throws InitializeException |
|
| 91 |
* @throws ProviderNotRegisteredException |
|
| 92 |
*/ |
|
| 75 | 93 |
public DataExplorer createExplorer( |
| 76 | 94 |
DataExplorerParameters parameters) |
| 77 | 95 |
throws InitializeException, ProviderNotRegisteredException; |
| 78 | 96 |
|
| 79 | 97 |
|
| 98 |
/** |
|
| 99 |
* Returns a list of String containing the names of the available DataExplorer providers. |
|
| 100 |
* |
|
| 101 |
* @return list of String containing the names of the available DataExplorer providers. |
|
| 102 |
*/ |
|
| 80 | 103 |
public List getExplorerProviders(); |
| 81 | 104 |
|
| 82 | 105 |
/* |
| 83 | 106 |
* ==================================================================== |
| 84 | 107 |
* |
| 85 |
* Expresion evaluation related services |
|
| 108 |
* Expression evaluation related services
|
|
| 86 | 109 |
*/ |
| 87 | 110 |
|
| 111 |
/** |
|
| 112 |
* Registers the default expression evaluator. It is used by DAL to evaluate and resolve |
|
| 113 |
* query filters and expressions. |
|
| 114 |
* |
|
| 115 |
* @param evaluator |
|
| 116 |
* Class that will be called to evaluate the expression. It must implement {@link Evaluator}.
|
|
| 117 |
*/ |
|
| 88 | 118 |
public void registerDefaultEvaluator(Class evaluator); |
| 89 | 119 |
|
| 120 |
/** |
|
| 121 |
* Creates an instance of Evaluator that represents the given expression. |
|
| 122 |
* |
|
| 123 |
* @param expresion String containing a CQL expression. |
|
| 124 |
* @return instance of Evaluator representing the given expression. |
|
| 125 |
* @throws InitializeException |
|
| 126 |
*/ |
|
| 90 | 127 |
public Evaluator createExpresion(String expresion) |
| 91 | 128 |
throws InitializeException; |
| 92 | 129 |
|
| ... | ... | |
| 98 | 135 |
|
| 99 | 136 |
|
| 100 | 137 |
/** |
| 101 |
* Returns an array of index provider names.
|
|
| 138 |
* Returns a list of String containing the names of the available index providers.
|
|
| 102 | 139 |
* |
| 103 |
* @param dataType |
|
| 104 |
* @return list of strings with the names of index providers |
|
| 140 |
* @return list of strings with the names of the available index providers |
|
| 105 | 141 |
*/ |
| 106 | 142 |
public List getFeatureIndexProviders(); |
| 107 | 143 |
|
| ... | ... | |
| 113 | 149 |
public void setDefaultFeatureIndexProviderName(int dataType, String name); |
| 114 | 150 |
|
| 115 | 151 |
/** |
| 116 |
* Returns the default DataIndexProvider name, given a data type. |
|
| 117 |
* @param dataType |
|
| 118 |
* @return |
|
| 152 |
* Returns the default DataIndexProvider name, given a data type. Data types are defined in {@link DataTypes}.
|
|
| 153 |
* |
|
| 154 |
* @param dataType, one of the constants in {@link DataTypes}.
|
|
| 155 |
* @return An instance of DataIndexProvider if there is anyone available for the given data type. |
|
| 119 | 156 |
*/ |
| 120 | 157 |
public String getDefaultFeatureIndexProviderName(int dataType); |
| 121 | 158 |
|
Also available in: Unified diff