svn-gvsig-desktop / trunk / org.gvsig.desktop / org.gvsig.desktop.compat.cdc / org.gvsig.fmap.dal / org.gvsig.fmap.dal.api / src / main / java / org / gvsig / fmap / dal / DataManager.java @ 43020
History | View | Annotate | Download (13.5 KB)
1 |
/**
|
---|---|
2 |
* gvSIG. Desktop Geographic Information System.
|
3 |
*
|
4 |
* Copyright (C) 2007-2013 gvSIG Association.
|
5 |
*
|
6 |
* This program is free software; you can redistribute it and/or modify it under
|
7 |
* the terms of the GNU General Public License as published by the Free Software
|
8 |
* Foundation; either version 3 of the License, or (at your option) any later
|
9 |
* version.
|
10 |
*
|
11 |
* This program is distributed in the hope that it will be useful, but WITHOUT
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
13 |
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
14 |
* details.
|
15 |
*
|
16 |
* You should have received a copy of the GNU General Public License along with
|
17 |
* this program; if not, write to the Free Software Foundation, Inc., 51
|
18 |
* Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
19 |
*
|
20 |
* For any additional information, do not hesitate to contact us at info AT
|
21 |
* gvsig.com, or visit our website www.gvsig.com.
|
22 |
*/
|
23 |
package org.gvsig.fmap.dal; |
24 |
|
25 |
import java.io.File; |
26 |
import java.util.List; |
27 |
|
28 |
import org.gvsig.fmap.dal.exception.InitializeException; |
29 |
import org.gvsig.fmap.dal.exception.ProviderNotRegisteredException; |
30 |
import org.gvsig.fmap.dal.exception.ValidateDataParametersException; |
31 |
import org.gvsig.fmap.dal.feature.EditableFeatureType; |
32 |
import org.gvsig.fmap.dal.feature.Feature; |
33 |
import org.gvsig.fmap.dal.feature.FeatureIndex; |
34 |
import org.gvsig.fmap.dal.feature.FeatureQuery; |
35 |
import org.gvsig.fmap.dal.feature.FeatureStore; |
36 |
import org.gvsig.fmap.dal.feature.paging.FeaturePagingHelper; |
37 |
import org.gvsig.fmap.dal.resource.ResourceManager; |
38 |
import org.gvsig.tools.dataTypes.DataType; |
39 |
import org.gvsig.tools.dynobject.DynObject; |
40 |
import org.gvsig.tools.dynobject.DynStruct; |
41 |
import org.gvsig.tools.dynobject.Tags; |
42 |
import org.gvsig.tools.evaluator.Evaluator; |
43 |
import org.gvsig.tools.exception.BaseException; |
44 |
import org.gvsig.tools.service.spi.Services; |
45 |
|
46 |
/**
|
47 |
* There are two top level management roles within DAL: data access and resource
|
48 |
* management.
|
49 |
*
|
50 |
* This class is responsible of the data access management role. It provides
|
51 |
* ways for registering and instantiating {@link DataServerExplorer}(s),
|
52 |
* {@link DataStore}(s), {@link Evaluator}(s) and {@link FeatureIndex}(es).
|
53 |
*
|
54 |
* @see ResourceManager
|
55 |
*
|
56 |
*/
|
57 |
public interface DataManager extends Services { |
58 |
|
59 |
public static final String CREATE_STORE_AUTHORIZATION = "dal-create-store"; |
60 |
public static final String READ_STORE_AUTHORIZATION = "dal-read-store"; |
61 |
public static final String WRITE_STORE_AUTHORIZATION = "dal-write-store"; |
62 |
|
63 |
/**
|
64 |
* Returns the default DAL's temporary directory
|
65 |
*
|
66 |
* @return Temporary directory name
|
67 |
*/
|
68 |
public String getTemporaryDirectory(); |
69 |
|
70 |
/*
|
71 |
* ====================================================================
|
72 |
*
|
73 |
* Store related services
|
74 |
*/
|
75 |
/**
|
76 |
* Creates, initializes and returns an instance of DataStoreParameters given
|
77 |
* the name with which their provider is registered.
|
78 |
*
|
79 |
* @param name provider name
|
80 |
* @return the data store parameters
|
81 |
*
|
82 |
* @throws ProviderNotRegisteredException if the memory provider is not
|
83 |
* registered
|
84 |
* @throws InitializeException if there is an error initializing the
|
85 |
* parameters for the memory provider
|
86 |
*
|
87 |
*/
|
88 |
public DataStoreParameters createStoreParameters(String name) |
89 |
throws InitializeException, ProviderNotRegisteredException;
|
90 |
|
91 |
/**
|
92 |
* Creates, initializes and fill an instance of DataStoreParameters from the
|
93 |
* tags of the DynStruct passed as parameter.
|
94 |
*
|
95 |
* @param struct structure from which tags were created ths parameters.
|
96 |
* @return the data store parameters
|
97 |
*
|
98 |
* @throws ProviderNotRegisteredException if the memory provider is not
|
99 |
* registered
|
100 |
* @throws InitializeException if there is an error initializing the
|
101 |
* parameters for the memory provider
|
102 |
*
|
103 |
*/
|
104 |
public DataStoreParameters createStoreParameters(DynStruct struct)
|
105 |
throws InitializeException, ProviderNotRegisteredException;
|
106 |
|
107 |
public DataStoreParameters createStoreParameters(Tags tags) throws InitializeException, ProviderNotRegisteredException; |
108 |
|
109 |
/**
|
110 |
* Creates, initializes and returns an instance of NewDataStoreParameters
|
111 |
* given the name with which their provider is registered.
|
112 |
*
|
113 |
* @param explorer
|
114 |
* @param provider
|
115 |
* @return
|
116 |
*
|
117 |
* @throws InitializeException
|
118 |
* @throws ProviderNotRegisteredException
|
119 |
*/
|
120 |
public NewDataStoreParameters createNewStoreParameters(String explorer, String provider) |
121 |
throws InitializeException, ProviderNotRegisteredException;
|
122 |
|
123 |
/**
|
124 |
*
|
125 |
* Creates, initializes and returns an instance of DataStore given the
|
126 |
* DataStoreParameters.
|
127 |
*
|
128 |
* @param provider
|
129 |
* @param parameters parameters used to instantiate and initialize the
|
130 |
* DataStore
|
131 |
* @return
|
132 |
*
|
133 |
* @throws ProviderNotRegisteredException if the memory provider is not
|
134 |
* registered
|
135 |
* @throws InitializeException if there is an error initializing the
|
136 |
* parameters for the memory provider
|
137 |
* @throws ValidateDataParametersException if the parameters to open the
|
138 |
* memory based store are not valid
|
139 |
*/
|
140 |
public DataStore openStore(String provider, DynObject parameters) |
141 |
throws InitializeException, ProviderNotRegisteredException,
|
142 |
ValidateDataParametersException; |
143 |
|
144 |
public DataStore openStore(String provider, DataStoreParameters parameters) |
145 |
throws InitializeException, ProviderNotRegisteredException,
|
146 |
ValidateDataParametersException; |
147 |
|
148 |
public DataStore openStore(DynStruct struct)
|
149 |
throws InitializeException, ProviderNotRegisteredException, ValidateDataParametersException;
|
150 |
|
151 |
/**
|
152 |
* Create a new physical store
|
153 |
*
|
154 |
* @param explorer
|
155 |
* @param provider
|
156 |
* @param parameters
|
157 |
* @param overwrite
|
158 |
*
|
159 |
* @throws InitializeException
|
160 |
* @throws ProviderNotRegisteredException
|
161 |
* @throws ValidateDataParametersException
|
162 |
*/
|
163 |
public void newStore(String explorer, String provider, NewDataStoreParameters parameters, boolean overwrite) |
164 |
throws InitializeException, ProviderNotRegisteredException,
|
165 |
ValidateDataParametersException; |
166 |
|
167 |
/**
|
168 |
* Returns a list of Strings containing the names of all available DataStore
|
169 |
* providers.
|
170 |
*
|
171 |
* @return list of String containing available DataStore provider names
|
172 |
*/
|
173 |
public List getStoreProviders(); |
174 |
|
175 |
/**
|
176 |
* Returns a list of Strings containing the names of all available DataStore
|
177 |
* providers for an explorer.
|
178 |
*
|
179 |
* @param name
|
180 |
* @return
|
181 |
*/
|
182 |
public List<String> getStoreProviders(String name); |
183 |
|
184 |
/*
|
185 |
* ====================================================================
|
186 |
*
|
187 |
* Explorer related services
|
188 |
*/
|
189 |
/**
|
190 |
* Returns an instance of {@link DataServerExplorerParameters} corresponding
|
191 |
* to the given name.
|
192 |
*
|
193 |
* @param name name of a registered server explorer provider
|
194 |
* @return
|
195 |
*
|
196 |
* @throws InitializeException if parameter initialization causes an error.
|
197 |
*
|
198 |
* @throws ProviderNotRegisteredException if could not find a provider by
|
199 |
* the given name.
|
200 |
*
|
201 |
*
|
202 |
*/
|
203 |
public DataServerExplorerParameters createServerExplorerParameters(
|
204 |
String name)
|
205 |
throws InitializeException, ProviderNotRegisteredException;
|
206 |
|
207 |
/**
|
208 |
* Returns an instance of {@link DataServerExplorer} given its parameters.
|
209 |
*
|
210 |
* @param name
|
211 |
* @param parameters parameters used to instantiate and initialize the
|
212 |
* {@link DataServerExplorer}.
|
213 |
*
|
214 |
* @return an instance of {@link DataServerExplorer}.
|
215 |
*
|
216 |
* @throws InitializeException
|
217 |
*
|
218 |
* @throws ProviderNotRegisteredException
|
219 |
* @throws ValidateDataParametersException
|
220 |
*/
|
221 |
public DataServerExplorer openServerExplorer(
|
222 |
String name,
|
223 |
DataServerExplorerParameters parameters) |
224 |
throws InitializeException, ProviderNotRegisteredException,
|
225 |
ValidateDataParametersException; |
226 |
|
227 |
/**
|
228 |
* @deprecated see openServerExplorer
|
229 |
*/
|
230 |
public DataServerExplorer createServerExplorer(
|
231 |
DataServerExplorerParameters parameters) |
232 |
throws InitializeException, ProviderNotRegisteredException,
|
233 |
ValidateDataParametersException; |
234 |
|
235 |
/**
|
236 |
* Returns a list of String containing the names of the available
|
237 |
* DataServerExplorer providers.
|
238 |
*
|
239 |
* @return list of String containing the names of the available
|
240 |
* DataServerExplorer providers.
|
241 |
*/
|
242 |
public List<String> getExplorerProviders(); |
243 |
|
244 |
/*
|
245 |
* ====================================================================
|
246 |
*
|
247 |
* Expression evaluation related services
|
248 |
*/
|
249 |
/**
|
250 |
* Registers the default expression evaluator. It is used by DAL to evaluate
|
251 |
* and resolve query filters and expressions.
|
252 |
*
|
253 |
* @param evaluator Class that will be called to evaluate the expression. It
|
254 |
* must implement {@link Evaluator}.
|
255 |
*/
|
256 |
public void registerDefaultEvaluator(Class evaluator); |
257 |
|
258 |
/**
|
259 |
* Creates an instance of Evaluator that represents the given expression.
|
260 |
*
|
261 |
* @param expression String containing a CQL expression.
|
262 |
* @return instance of Evaluator representing the given expression.
|
263 |
* @throws InitializeException
|
264 |
*/
|
265 |
public Evaluator createExpresion(String expression) |
266 |
throws InitializeException;
|
267 |
|
268 |
/*
|
269 |
* ====================================================================
|
270 |
*
|
271 |
* Index related services
|
272 |
*/
|
273 |
/**
|
274 |
* Returns a list of String containing the names of the available index
|
275 |
* providers.
|
276 |
*
|
277 |
* @return list of strings with the names of the available index providers
|
278 |
*/
|
279 |
public List<String> getFeatureIndexProviders(); |
280 |
|
281 |
/**
|
282 |
* Sets the default DataIndexProvider for the given data type.
|
283 |
*
|
284 |
* @param dataType one of the data types defined in {@link DataTypes}.
|
285 |
* @param name Provider's name
|
286 |
*/
|
287 |
public void setDefaultFeatureIndexProviderName(int dataType, String name); |
288 |
|
289 |
/**
|
290 |
* Returns the default DataIndexProvider name, given a data type. Data types
|
291 |
* are defined in {@link DataTypes}.
|
292 |
*
|
293 |
* @param dataType one of the constants in {@link DataTypes}.
|
294 |
*
|
295 |
* @return the name of the default {@link FeatureIndexProvider} if there is
|
296 |
* anyone available for the given data type.
|
297 |
*/
|
298 |
public String getDefaultFeatureIndexProviderName(int dataType); |
299 |
|
300 |
/**
|
301 |
* Utility method to create the {@link DataStoreParameters} to create a
|
302 |
* {@link FeatureStore} based on the {@link MemoryStoreProvider}.
|
303 |
*
|
304 |
* @param autoOrderAttributeName the name of the {@link Feature} attribute
|
305 |
* to be used to order the store {@link Feature}s by default. Set to null if
|
306 |
* you don't want any order by default
|
307 |
* @return the parameters for the memory based store
|
308 |
* @throws InitializeException if there is an error initializing the
|
309 |
* parameters for the memory provider
|
310 |
*/
|
311 |
public DataStoreParameters createMemoryStoreParameters(
|
312 |
String autoOrderAttributeName) throws InitializeException; |
313 |
|
314 |
/**
|
315 |
* Utility method to create the a {@link FeatureStore} based on the
|
316 |
* {@link MemoryStoreProvider}.
|
317 |
*
|
318 |
* @param autoOrderAttributeName the name of the {@link Feature} attribute
|
319 |
* to be used to order the store {@link Feature}s by default. Set to null if
|
320 |
* you don't want any order by default
|
321 |
* @return the the memory based store
|
322 |
* @throws InitializeException if there is an error initializing the
|
323 |
* parameters for the memory provider
|
324 |
*/
|
325 |
public FeatureStore createMemoryStore(String autoOrderAttributeName) |
326 |
throws InitializeException;
|
327 |
|
328 |
/**
|
329 |
* Creates a {@link FeaturePagingHelper} to paginate data from a
|
330 |
* {@link FeatureStore}.
|
331 |
*
|
332 |
* @param featureStore to get the {@link Feature}s from
|
333 |
* @param pageSize the page size
|
334 |
* @return a {@link FeaturePagingHelper}
|
335 |
* @throws BaseException if there is an error creating the helper
|
336 |
*/
|
337 |
public FeaturePagingHelper createFeaturePagingHelper(
|
338 |
FeatureStore featureStore, int pageSize) throws BaseException; |
339 |
|
340 |
/**
|
341 |
* Creates a {@link FeaturePagingHelper} to paginate data from a
|
342 |
* {@link FeatureStore}.
|
343 |
*
|
344 |
* @param featureStore to get the {@link Feature}s from
|
345 |
* @param featureQuery to filter and/or order the data
|
346 |
* @param pageSize the page size
|
347 |
* @return a {@link FeaturePagingHelper}
|
348 |
* @throws BaseException if there is an error creating the helper
|
349 |
*/
|
350 |
public FeaturePagingHelper createFeaturePagingHelper(
|
351 |
FeatureStore featureStore, FeatureQuery featureQuery, int pageSize)
|
352 |
throws BaseException;
|
353 |
|
354 |
public void setOpenErrorHandler(OpenErrorHandler handler); |
355 |
|
356 |
public OpenErrorHandler getOpenErrorHandler();
|
357 |
|
358 |
public DataStoreProviderFactory getStoreProviderFactory(String name); |
359 |
|
360 |
public EditableFeatureType createFeatureType();
|
361 |
|
362 |
public DataServerExplorerPool getDataServerExplorerPool();
|
363 |
|
364 |
public void setDataServerExplorerPool(DataServerExplorerPool pool); |
365 |
|
366 |
public void setResourcesLoader(ClassLoader loader); |
367 |
|
368 |
public void setResourcesLoader(File folder); |
369 |
|
370 |
/**
|
371 |
* Return a list of the DataTypes supported for the type of the feature
|
372 |
* attributes. The list is only informative.
|
373 |
*
|
374 |
* @return
|
375 |
*/
|
376 |
public List<DataType> getDataTypes(); |
377 |
|
378 |
public Register getStoreRegister();
|
379 |
|
380 |
public Register getStoreProviderRegister();
|
381 |
|
382 |
public Register getServerExplorerRegister();
|
383 |
|
384 |
public Register getFeatureIndexRegister();
|
385 |
} |