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 @ 43045
History | View | Annotate | Download (14.6 KB)
1 | 40559 | jjdelcerro | /**
|
---|---|---|---|
2 | * gvSIG. Desktop Geographic Information System.
|
||
3 | 40435 | jjdelcerro | *
|
4 | 40559 | jjdelcerro | * Copyright (C) 2007-2013 gvSIG Association.
|
5 | 40435 | jjdelcerro | *
|
6 | 43020 | jjdelcerro | * 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 | 40435 | jjdelcerro | *
|
11 | 43020 | jjdelcerro | * 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 | 40435 | jjdelcerro | *
|
16 | 43020 | jjdelcerro | * 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 | 40435 | jjdelcerro | *
|
20 | 43020 | jjdelcerro | * For any additional information, do not hesitate to contact us at info AT
|
21 | * gvsig.com, or visit our website www.gvsig.com.
|
||
22 | 40435 | jjdelcerro | */
|
23 | package org.gvsig.fmap.dal; |
||
24 | |||
25 | 43020 | jjdelcerro | import java.io.File; |
26 | 40435 | jjdelcerro | 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 | 42775 | jjdelcerro | import org.gvsig.fmap.dal.resource.ResourceManager; |
38 | 43020 | jjdelcerro | import org.gvsig.tools.dataTypes.DataType; |
39 | 40435 | jjdelcerro | import org.gvsig.tools.dynobject.DynObject; |
40 | 42775 | jjdelcerro | import org.gvsig.tools.dynobject.DynStruct; |
41 | 42778 | jjdelcerro | import org.gvsig.tools.dynobject.Tags; |
42 | 40435 | jjdelcerro | import org.gvsig.tools.evaluator.Evaluator; |
43 | import org.gvsig.tools.exception.BaseException; |
||
44 | 43020 | jjdelcerro | import org.gvsig.tools.service.spi.Services; |
45 | 40435 | jjdelcerro | |
46 | /**
|
||
47 | 43020 | jjdelcerro | * There are two top level management roles within DAL: data access and resource
|
48 | * management.
|
||
49 | 40435 | jjdelcerro | *
|
50 | 43020 | jjdelcerro | * 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 | 40435 | jjdelcerro | *
|
54 | * @see ResourceManager
|
||
55 | *
|
||
56 | */
|
||
57 | 43020 | jjdelcerro | public interface DataManager extends Services { |
58 | 40435 | jjdelcerro | |
59 | 43020 | jjdelcerro | 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 | 40435 | jjdelcerro | |
63 | 43020 | jjdelcerro | /**
|
64 | * Returns the default DAL's temporary directory
|
||
65 | *
|
||
66 | * @return Temporary directory name
|
||
67 | */
|
||
68 | public String getTemporaryDirectory(); |
||
69 | 40435 | jjdelcerro | |
70 | 43020 | jjdelcerro | /*
|
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 | 40435 | jjdelcerro | |
91 | 43020 | jjdelcerro | /**
|
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 | 40435 | jjdelcerro | |
107 | 43020 | jjdelcerro | public DataStoreParameters createStoreParameters(Tags tags) throws InitializeException, ProviderNotRegisteredException; |
108 | 42778 | jjdelcerro | |
109 | 43020 | jjdelcerro | /**
|
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 | 40435 | jjdelcerro | |
123 | 43020 | jjdelcerro | /**
|
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 | 40435 | jjdelcerro | |
144 | 43020 | jjdelcerro | public DataStore openStore(String provider, DataStoreParameters parameters) |
145 | throws InitializeException, ProviderNotRegisteredException,
|
||
146 | ValidateDataParametersException; |
||
147 | 42775 | jjdelcerro | |
148 | 43020 | jjdelcerro | public DataStore openStore(DynStruct struct)
|
149 | throws InitializeException, ProviderNotRegisteredException, ValidateDataParametersException;
|
||
150 | 42775 | jjdelcerro | |
151 | 43020 | jjdelcerro | /**
|
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 | 40435 | jjdelcerro | |
167 | 43020 | jjdelcerro | /**
|
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 | 42624 | jjdelcerro | |
175 | 43020 | jjdelcerro | /**
|
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 | 42624 | jjdelcerro | |
184 | 43020 | jjdelcerro | /*
|
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 | 40435 | jjdelcerro | |
207 | 43020 | jjdelcerro | /**
|
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 | 40435 | jjdelcerro | |
227 | 43020 | jjdelcerro | /**
|
228 | 43045 | jjdelcerro | * @param parameters
|
229 | * @return
|
||
230 | * @throws org.gvsig.fmap.dal.exception.InitializeException
|
||
231 | * @throws org.gvsig.fmap.dal.exception.ProviderNotRegisteredException
|
||
232 | * @throws org.gvsig.fmap.dal.exception.ValidateDataParametersException
|
||
233 | 43020 | jjdelcerro | * @deprecated see openServerExplorer
|
234 | */
|
||
235 | public DataServerExplorer createServerExplorer(
|
||
236 | DataServerExplorerParameters parameters) |
||
237 | throws InitializeException, ProviderNotRegisteredException,
|
||
238 | ValidateDataParametersException; |
||
239 | 43045 | jjdelcerro | |
240 | 43020 | jjdelcerro | /**
|
241 | 43045 | jjdelcerro | * @param parameters
|
242 | * @return
|
||
243 | * @throws org.gvsig.fmap.dal.exception.InitializeException
|
||
244 | * @throws org.gvsig.fmap.dal.exception.ProviderNotRegisteredException
|
||
245 | * @throws org.gvsig.fmap.dal.exception.ValidateDataParametersException
|
||
246 | * @deprecated see openStore
|
||
247 | */
|
||
248 | public DataStore createStore(DataStoreParameters parameters)
|
||
249 | throws InitializeException, ProviderNotRegisteredException,
|
||
250 | ValidateDataParametersException; |
||
251 | |||
252 | /**
|
||
253 | 43020 | jjdelcerro | * Returns a list of String containing the names of the available
|
254 | * DataServerExplorer providers.
|
||
255 | *
|
||
256 | * @return list of String containing the names of the available
|
||
257 | * DataServerExplorer providers.
|
||
258 | */
|
||
259 | public List<String> getExplorerProviders(); |
||
260 | 40435 | jjdelcerro | |
261 | 43020 | jjdelcerro | /*
|
262 | * ====================================================================
|
||
263 | *
|
||
264 | * Expression evaluation related services
|
||
265 | */
|
||
266 | /**
|
||
267 | * Registers the default expression evaluator. It is used by DAL to evaluate
|
||
268 | * and resolve query filters and expressions.
|
||
269 | *
|
||
270 | * @param evaluator Class that will be called to evaluate the expression. It
|
||
271 | * must implement {@link Evaluator}.
|
||
272 | */
|
||
273 | public void registerDefaultEvaluator(Class evaluator); |
||
274 | 40435 | jjdelcerro | |
275 | 43020 | jjdelcerro | /**
|
276 | * Creates an instance of Evaluator that represents the given expression.
|
||
277 | *
|
||
278 | * @param expression String containing a CQL expression.
|
||
279 | * @return instance of Evaluator representing the given expression.
|
||
280 | * @throws InitializeException
|
||
281 | */
|
||
282 | public Evaluator createExpresion(String expression) |
||
283 | throws InitializeException;
|
||
284 | 40435 | jjdelcerro | |
285 | 43020 | jjdelcerro | /*
|
286 | * ====================================================================
|
||
287 | *
|
||
288 | * Index related services
|
||
289 | */
|
||
290 | /**
|
||
291 | * Returns a list of String containing the names of the available index
|
||
292 | * providers.
|
||
293 | *
|
||
294 | * @return list of strings with the names of the available index providers
|
||
295 | */
|
||
296 | public List<String> getFeatureIndexProviders(); |
||
297 | 40435 | jjdelcerro | |
298 | 43020 | jjdelcerro | /**
|
299 | * Sets the default DataIndexProvider for the given data type.
|
||
300 | *
|
||
301 | * @param dataType one of the data types defined in {@link DataTypes}.
|
||
302 | * @param name Provider's name
|
||
303 | */
|
||
304 | 40435 | jjdelcerro | public void setDefaultFeatureIndexProviderName(int dataType, String name); |
305 | |||
306 | 43020 | jjdelcerro | /**
|
307 | * Returns the default DataIndexProvider name, given a data type. Data types
|
||
308 | * are defined in {@link DataTypes}.
|
||
309 | *
|
||
310 | * @param dataType one of the constants in {@link DataTypes}.
|
||
311 | *
|
||
312 | * @return the name of the default {@link FeatureIndexProvider} if there is
|
||
313 | * anyone available for the given data type.
|
||
314 | */
|
||
315 | 40435 | jjdelcerro | public String getDefaultFeatureIndexProviderName(int dataType); |
316 | |||
317 | /**
|
||
318 | 43020 | jjdelcerro | * Utility method to create the {@link DataStoreParameters} to create a
|
319 | * {@link FeatureStore} based on the {@link MemoryStoreProvider}.
|
||
320 | *
|
||
321 | * @param autoOrderAttributeName the name of the {@link Feature} attribute
|
||
322 | * to be used to order the store {@link Feature}s by default. Set to null if
|
||
323 | * you don't want any order by default
|
||
324 | * @return the parameters for the memory based store
|
||
325 | * @throws InitializeException if there is an error initializing the
|
||
326 | * parameters for the memory provider
|
||
327 | */
|
||
328 | public DataStoreParameters createMemoryStoreParameters(
|
||
329 | String autoOrderAttributeName) throws InitializeException; |
||
330 | 40435 | jjdelcerro | |
331 | 43020 | jjdelcerro | /**
|
332 | * Utility method to create the a {@link FeatureStore} based on the
|
||
333 | * {@link MemoryStoreProvider}.
|
||
334 | *
|
||
335 | * @param autoOrderAttributeName the name of the {@link Feature} attribute
|
||
336 | * to be used to order the store {@link Feature}s by default. Set to null if
|
||
337 | * you don't want any order by default
|
||
338 | * @return the the memory based store
|
||
339 | * @throws InitializeException if there is an error initializing the
|
||
340 | * parameters for the memory provider
|
||
341 | */
|
||
342 | public FeatureStore createMemoryStore(String autoOrderAttributeName) |
||
343 | throws InitializeException;
|
||
344 | 40435 | jjdelcerro | |
345 | /**
|
||
346 | * Creates a {@link FeaturePagingHelper} to paginate data from a
|
||
347 | * {@link FeatureStore}.
|
||
348 | 43020 | jjdelcerro | *
|
349 | * @param featureStore to get the {@link Feature}s from
|
||
350 | * @param pageSize the page size
|
||
351 | 40435 | jjdelcerro | * @return a {@link FeaturePagingHelper}
|
352 | 43020 | jjdelcerro | * @throws BaseException if there is an error creating the helper
|
353 | 40435 | jjdelcerro | */
|
354 | 43020 | jjdelcerro | public FeaturePagingHelper createFeaturePagingHelper(
|
355 | FeatureStore featureStore, int pageSize) throws BaseException; |
||
356 | 40435 | jjdelcerro | |
357 | 43020 | jjdelcerro | /**
|
358 | 40435 | jjdelcerro | * Creates a {@link FeaturePagingHelper} to paginate data from a
|
359 | * {@link FeatureStore}.
|
||
360 | 43020 | jjdelcerro | *
|
361 | * @param featureStore to get the {@link Feature}s from
|
||
362 | * @param featureQuery to filter and/or order the data
|
||
363 | * @param pageSize the page size
|
||
364 | 40435 | jjdelcerro | * @return a {@link FeaturePagingHelper}
|
365 | 43020 | jjdelcerro | * @throws BaseException if there is an error creating the helper
|
366 | 40435 | jjdelcerro | */
|
367 | 43020 | jjdelcerro | public FeaturePagingHelper createFeaturePagingHelper(
|
368 | FeatureStore featureStore, FeatureQuery featureQuery, int pageSize)
|
||
369 | throws BaseException;
|
||
370 | 40435 | jjdelcerro | |
371 | 43020 | jjdelcerro | public void setOpenErrorHandler(OpenErrorHandler handler); |
372 | 42775 | jjdelcerro | |
373 | 43020 | jjdelcerro | public OpenErrorHandler getOpenErrorHandler();
|
374 | |||
375 | public DataStoreProviderFactory getStoreProviderFactory(String name); |
||
376 | |||
377 | public EditableFeatureType createFeatureType();
|
||
378 | |||
379 | public DataServerExplorerPool getDataServerExplorerPool();
|
||
380 | |||
381 | public void setDataServerExplorerPool(DataServerExplorerPool pool); |
||
382 | |||
383 | public void setResourcesLoader(ClassLoader loader); |
||
384 | |||
385 | public void setResourcesLoader(File folder); |
||
386 | |||
387 | /**
|
||
388 | * Return a list of the DataTypes supported for the type of the feature
|
||
389 | * attributes. The list is only informative.
|
||
390 | *
|
||
391 | * @return
|
||
392 | */
|
||
393 | public List<DataType> getDataTypes(); |
||
394 | |||
395 | public Register getStoreRegister();
|
||
396 | |||
397 | public Register getStoreProviderRegister();
|
||
398 | |||
399 | public Register getServerExplorerRegister();
|
||
400 | |||
401 | public Register getFeatureIndexRegister();
|
||
402 | 43040 | jjdelcerro | |
403 | /**
|
||
404 | * Creates a default ExpressionBuilder.
|
||
405 | *
|
||
406 | * This ExpressionBuilder is not dependent on a data source,
|
||
407 | * and is not advisable to use it.
|
||
408 | *
|
||
409 | * @return the ExpressionBuilder
|
||
410 | */
|
||
411 | public ExpressionBuilder createExpressionBuilder();
|
||
412 | 40596 | jjdelcerro | } |