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 / DataStore.java @ 46966
History | View | Annotate | Download (11.6 KB)
1 | 40559 | jjdelcerro | /**
|
---|---|---|---|
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
|
||
7 | * modify it under the terms of the GNU General Public License
|
||
8 | * as published by the Free Software Foundation; either version 3
|
||
9 | * of the License, or (at your option) any later version.
|
||
10 | *
|
||
11 | * This program is distributed in the hope that it will be useful,
|
||
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
14 | * GNU General Public License for more details.
|
||
15 | *
|
||
16 | * You should have received a copy of the GNU General Public License
|
||
17 | * along with this program; if not, write to the Free Software
|
||
18 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
||
19 | * MA 02110-1301, USA.
|
||
20 | *
|
||
21 | * For any additional information, do not hesitate to contact us
|
||
22 | * at info AT gvsig.com, or visit our website www.gvsig.com.
|
||
23 | */
|
||
24 | 40435 | jjdelcerro | package org.gvsig.fmap.dal; |
25 | |||
26 | import java.util.Collection; |
||
27 | |||
28 | import org.gvsig.fmap.dal.exception.DataException; |
||
29 | import org.gvsig.fmap.dal.exception.ValidateDataParametersException; |
||
30 | import org.gvsig.metadata.Metadata; |
||
31 | import org.gvsig.timesupport.Interval; |
||
32 | import org.gvsig.timesupport.Time; |
||
33 | import org.gvsig.tools.dispose.Disposable; |
||
34 | 43152 | fdiaz | import org.gvsig.tools.dynobject.DynObject; |
35 | 43246 | jjdelcerro | import org.gvsig.tools.dynobject.DynObject_v2; |
36 | 40435 | jjdelcerro | import org.gvsig.tools.exception.BaseException; |
37 | import org.gvsig.tools.observer.ComplexWeakReferencingObservable; |
||
38 | import org.gvsig.tools.observer.Observer; |
||
39 | import org.gvsig.tools.persistence.Persistent; |
||
40 | 44297 | jjdelcerro | import org.gvsig.tools.resourcesstorage.ResourcesStorage; |
41 | 43020 | jjdelcerro | import org.gvsig.tools.service.spi.Services; |
42 | 44259 | jjdelcerro | import org.gvsig.tools.util.UnmodifiableBasicMap; |
43 | 40435 | jjdelcerro | import org.gvsig.tools.visitor.Visitable; |
44 | import org.gvsig.tools.visitor.Visitor; |
||
45 | |||
46 | /**
|
||
47 | * <p>
|
||
48 | * This is the basic interface for all data stores. Depending on the context, it
|
||
49 | * can represent a geographic layer, an alphanumeric database table or any data
|
||
50 | * file. DataStore offers generic services like:
|
||
51 | * <ul>
|
||
52 | * <li>Open and close data stores</li>
|
||
53 | * <li>Access to data sets, with the possibility of loading data in background.</li>
|
||
54 | * <li>Use of selection and locks, as well as data sets</li>
|
||
55 | * <li>Editing</li>
|
||
56 | * <li>Register event observers through the Observable interface</li>
|
||
57 | * <li>Access to embedded data stores (like GML)</li>
|
||
58 | * <li>Information about the Spatial Reference Systems used by the data store</li>
|
||
59 | * </ul>
|
||
60 | * </p>
|
||
61 | * <br>
|
||
62 | *
|
||
63 | */
|
||
64 | public interface DataStore extends ComplexWeakReferencingObservable, |
||
65 | 43246 | jjdelcerro | Persistent, Metadata, Disposable, Visitable, DataFactoryUnit, Services, DynObject_v2 { |
66 | 40435 | jjdelcerro | |
67 | 46733 | jjdelcerro | public static String getFullNameQuietly(DataStore store) { |
68 | try {
|
||
69 | return store.getFullName();
|
||
70 | } catch(Throwable th) { |
||
71 | return null; |
||
72 | } |
||
73 | } |
||
74 | 46819 | jjdelcerro | |
75 | public static String getNameQuietly(DataStore store) { |
||
76 | try {
|
||
77 | return store.getName();
|
||
78 | } catch(Throwable th) { |
||
79 | return null; |
||
80 | } |
||
81 | } |
||
82 | 44669 | jjdelcerro | public static final String SHAPE_PROVIDER_NAME = "Shape"; |
83 | public static final String DBASE_PROVIDER_NAME = "DBF"; |
||
84 | public static final String CSV_PROVIDER_NAME = "CSV"; |
||
85 | public static final String H2SPATIAL_PROVIDER_NAME = "H2Spatial"; |
||
86 | 44915 | omartinez | public static final String MDB_PROVIDER_NAME = "MDB"; |
87 | 44669 | jjdelcerro | |
88 | 40435 | jjdelcerro | public static final String METADATA_DEFINITION_NAME = "DataProvider"; |
89 | |||
90 | public static final String FEATURE_METADATA_DEFINITION_NAME = "FeatureProvider"; |
||
91 | |||
92 | public static final String SPATIAL_METADATA_DEFINITION_NAME = "SpatialProvider"; |
||
93 | |||
94 | /**
|
||
95 | * Metadata property name for the provider name provided by the data provider.
|
||
96 | 43152 | fdiaz | *
|
97 | 40435 | jjdelcerro | * This metadata is provided by all data providers.
|
98 | */
|
||
99 | public static final String METADATA_PROVIDER = "ProviderName"; |
||
100 | |||
101 | /**
|
||
102 | * Metadata property name for Container name provided by the data provider.
|
||
103 | * By explample, in a dbf file, this is the name of dbf.
|
||
104 | 43152 | fdiaz | *
|
105 | 40435 | jjdelcerro | * This metadata is provided by all data providers.
|
106 | */
|
||
107 | public static final String METADATA_CONTAINERNAME = "ContainerName"; |
||
108 | |||
109 | /**
|
||
110 | * Metadata property name for the feature type provided by the data provider.
|
||
111 | 43152 | fdiaz | *
|
112 | 40435 | jjdelcerro | * This metadata is provided by all tabular data providers.
|
113 | */
|
||
114 | public static final String METADATA_FEATURETYPE = "FeatureType"; |
||
115 | |||
116 | /**
|
||
117 | * Metadata property name for CRS provided by the data provider.
|
||
118 | 43152 | fdiaz | *
|
119 | * This metadata is only provided by data provider with spatial
|
||
120 | 40435 | jjdelcerro | * information.
|
121 | */
|
||
122 | public static final String METADATA_CRS = "CRS"; |
||
123 | |||
124 | /**
|
||
125 | * Metadata property name for Envelope provided by the data provider
|
||
126 | 43152 | fdiaz | *
|
127 | * This metadata is only provided by data provider with spatial
|
||
128 | 40435 | jjdelcerro | * information.
|
129 | */
|
||
130 | public static final String METADATA_ENVELOPE = "Envelope"; |
||
131 | |||
132 | /**
|
||
133 | * Returns the name associated to the store.
|
||
134 | * This name is provided for informational purposes only.
|
||
135 | * Explamples:
|
||
136 | 43152 | fdiaz | *
|
137 | 40435 | jjdelcerro | * In a dbf the filename without the path
|
138 | 43152 | fdiaz | *
|
139 | 40435 | jjdelcerro | * In a DDBB table the name of the table
|
140 | 43152 | fdiaz | *
|
141 | 40435 | jjdelcerro | * In a WFS layer the name of the layer.
|
142 | *
|
||
143 | * @return String containing this store's name.
|
||
144 | */
|
||
145 | public String getName(); |
||
146 | 43152 | fdiaz | |
147 | 40435 | jjdelcerro | /**
|
148 | * Returns a more descriptive name for the store that getName.
|
||
149 | * This name is provided for informational purposes only.
|
||
150 | * Explamples:
|
||
151 | 43152 | fdiaz | *
|
152 | 40435 | jjdelcerro | * In a file based store may return the full name of the filename, path and filename.
|
153 | 43152 | fdiaz | *
|
154 | 40435 | jjdelcerro | * In a data base based store may return "server:dbname:tablename"
|
155 | 43152 | fdiaz | *
|
156 | 40435 | jjdelcerro | * In a WFS layer based store may return "server:layername"
|
157 | 43152 | fdiaz | *
|
158 | 40435 | jjdelcerro | * @return String Containing the full name of the store
|
159 | */
|
||
160 | public String getFullName(); |
||
161 | |||
162 | /**
|
||
163 | * Return the of parameters of this store
|
||
164 | *
|
||
165 | * @return parameters of this store
|
||
166 | */
|
||
167 | public DataStoreParameters getParameters();
|
||
168 | |||
169 | /**
|
||
170 | * Return the provider name that use this store.
|
||
171 | 43152 | fdiaz | *
|
172 | 40435 | jjdelcerro | * @return provider name of this store
|
173 | */
|
||
174 | public String getProviderName(); |
||
175 | 43152 | fdiaz | |
176 | 40435 | jjdelcerro | /**
|
177 | * Refreshes this store state.
|
||
178 | *
|
||
179 | * @throws DataException
|
||
180 | */
|
||
181 | public void refresh() throws DataException; |
||
182 | |||
183 | /**
|
||
184 | * Returns all available data.
|
||
185 | *
|
||
186 | * @return a set of data
|
||
187 | * @throws DataException
|
||
188 | * if there is any error while loading the data
|
||
189 | */
|
||
190 | DataSet getDataSet() throws DataException;
|
||
191 | |||
192 | /**
|
||
193 | * Returns a subset of data taking into account the properties and
|
||
194 | * restrictions of the DataQuery.
|
||
195 | *
|
||
196 | * @param dataQuery
|
||
197 | * defines the properties of the requested data
|
||
198 | * @return a set of data
|
||
199 | * @throws DataException
|
||
200 | * if there is any error while loading the data
|
||
201 | */
|
||
202 | DataSet getDataSet(DataQuery dataQuery) throws DataException;
|
||
203 | |||
204 | /**
|
||
205 | * Provides each value of this Store to the provided {@link Visitor}.
|
||
206 | * The values received through the {@link Visitor#visit(Object)} method
|
||
207 | * may be transient, reused or externally modifiable, so they can't
|
||
208 | * be used to be stored in any external form out of the visit method.
|
||
209 | 43152 | fdiaz | *
|
210 | 40435 | jjdelcerro | * If you need to store any of the values out of the
|
211 | * {@link Visitor#visit(Object)} method execution, create a copy or clone
|
||
212 | * the received value in order to be stored.
|
||
213 | 43152 | fdiaz | *
|
214 | 40435 | jjdelcerro | * @param visitor
|
215 | * the visitor to apply to each value.
|
||
216 | * @exception BaseException
|
||
217 | * if there is an error while performing the visit
|
||
218 | */
|
||
219 | public void accept(Visitor visitor) throws BaseException; |
||
220 | |||
221 | /**
|
||
222 | * Provides each value of this Store to the provided {@link Visitor}.
|
||
223 | * The values received through the {@link Visitor#visit(Object)} method
|
||
224 | * may be transient, reused or externally modifiable, so they can't
|
||
225 | * be used to be stored in any external form out of the visit method.
|
||
226 | 43152 | fdiaz | *
|
227 | 40435 | jjdelcerro | * If you need to store any of the values out of the
|
228 | * {@link Visitor#visit(Object)} method execution, create a copy or clone
|
||
229 | * the received value in order to be stored.
|
||
230 | 43152 | fdiaz | *
|
231 | 40435 | jjdelcerro | * @param visitor
|
232 | * the visitor to apply to each value.
|
||
233 | * @param dataQuery
|
||
234 | * defines the properties of the data to visit
|
||
235 | * @exception BaseException
|
||
236 | * if there is an error while performing the visit
|
||
237 | */
|
||
238 | public void accept(Visitor visitor, DataQuery dataQuery) |
||
239 | throws BaseException;
|
||
240 | |||
241 | /**
|
||
242 | * Loads all available data and notifies the observer for each loaded block of data.
|
||
243 | *
|
||
244 | * @param observer
|
||
245 | * to be notified for each block of data loaded
|
||
246 | * @throws DataException
|
||
247 | * if there is any error while loading the data
|
||
248 | */
|
||
249 | void getDataSet(Observer observer) throws DataException; |
||
250 | |||
251 | /**
|
||
252 | * Loads a subset of data taking into account the properties and
|
||
253 | * restrictions of the DataQuery. Data loading is performed by calling the
|
||
254 | * Observer, once each data block is loaded.
|
||
255 | *
|
||
256 | * @param dataQuery
|
||
257 | * defines the properties of the requested data
|
||
258 | * @param observer
|
||
259 | * to be notified for each block of data loaded
|
||
260 | * @throws DataException
|
||
261 | * if there is any error while loading the data
|
||
262 | */
|
||
263 | void getDataSet(DataQuery dataQuery, Observer observer) throws DataException; |
||
264 | |||
265 | /**
|
||
266 | * Returns the selected set of data
|
||
267 | *
|
||
268 | * @return DataSet
|
||
269 | 44669 | jjdelcerro | * @throws org.gvsig.fmap.dal.exception.DataException
|
270 | 40435 | jjdelcerro | */
|
271 | |||
272 | public DataSet getSelection() throws DataException; |
||
273 | |||
274 | /**
|
||
275 | * Sets the current data selection with the given data set.
|
||
276 | *
|
||
277 | 44669 | jjdelcerro | * @param selection
|
278 | 40435 | jjdelcerro | * @throws DataException
|
279 | */
|
||
280 | public void setSelection(DataSet selection) throws DataException; |
||
281 | |||
282 | /**
|
||
283 | * Creates a new selection.
|
||
284 | *
|
||
285 | * @return DataSet that contains the selection
|
||
286 | *
|
||
287 | * @throws DataException
|
||
288 | */
|
||
289 | public DataSet createSelection() throws DataException; |
||
290 | |||
291 | /**
|
||
292 | 44259 | jjdelcerro | * Returns an UnmodifiableBasicMap with this store children.
|
293 | * If do not have children, return an empty map.
|
||
294 | * Never returns null.
|
||
295 | 40435 | jjdelcerro | *
|
296 | 44259 | jjdelcerro | * @return an UnmodifiableBasicMap with this DataStore children
|
297 | 40435 | jjdelcerro | */
|
298 | 44259 | jjdelcerro | public UnmodifiableBasicMap<String,DataStore> getChildren(); |
299 | 44251 | jjdelcerro | |
300 | 40435 | jjdelcerro | |
301 | /**
|
||
302 | * Returns the DataServerExplorer to which this DataStore belongs, if there
|
||
303 | * is any.
|
||
304 | 43152 | fdiaz | *
|
305 | 40435 | jjdelcerro | * @return DataServerExplorer to which this DataStore belongs, or
|
306 | * <code>null</code> if this was not accessed through any
|
||
307 | * DataServerExplorer.
|
||
308 | 43152 | fdiaz | *
|
309 | 40435 | jjdelcerro | * @throws DataException
|
310 | * @throws ValidateDataParametersException
|
||
311 | */
|
||
312 | public DataServerExplorer getExplorer() throws DataException, |
||
313 | ValidateDataParametersException; |
||
314 | |||
315 | |||
316 | /**
|
||
317 | * Returns a new instance of a {@link DataQuery}.
|
||
318 | *
|
||
319 | * @return new {@link DataQuery} instance.
|
||
320 | */
|
||
321 | public DataQuery createQuery();
|
||
322 | 43152 | fdiaz | |
323 | 40435 | jjdelcerro | /**
|
324 | * Gets the {@link Interval} of the store, that means the temporal
|
||
325 | * interval where the store has valid data.
|
||
326 | * @return
|
||
327 | * a time interval or null if there is not time support
|
||
328 | */
|
||
329 | public Interval getInterval();
|
||
330 | 43152 | fdiaz | |
331 | 40435 | jjdelcerro | /**
|
332 | 43152 | fdiaz | * Gets all the possible values of time for which the store has data.
|
333 | 40435 | jjdelcerro | * @return
|
334 | * a collection of {@link Time} objects.
|
||
335 | */
|
||
336 | public Collection getTimes(); |
||
337 | 43152 | fdiaz | |
338 | 40435 | jjdelcerro | /**
|
339 | * Gets all the possible values of time for which the store has data
|
||
340 | * and intersects with an interval.
|
||
341 | * @param interval
|
||
342 | * the interval of time
|
||
343 | * @return
|
||
344 | * a collection of {@link Time} objects.
|
||
345 | */
|
||
346 | public Collection getTimes(Interval interval); |
||
347 | 43152 | fdiaz | |
348 | /**
|
||
349 | * @param providerName
|
||
350 | * @param parameters
|
||
351 | * @throws DataException
|
||
352 | */
|
||
353 | public void useCache(String providerName, DynObject parameters) throws DataException; |
||
354 | |||
355 | 43190 | jjdelcerro | public DataStoreProviderFactory getProviderFactory();
|
356 | 43755 | fdiaz | |
357 | /**
|
||
358 | * @return
|
||
359 | */
|
||
360 | public DataCache getCache();
|
||
361 | |||
362 | 44297 | jjdelcerro | public ResourcesStorage getResourcesStorage();
|
363 | |||
364 | public StoresRepository getStoresRepository();
|
||
365 | |||
366 | 40435 | jjdelcerro | } |