Revision 43152 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

View differences:

DataStore.java
32 32
import org.gvsig.timesupport.Interval;
33 33
import org.gvsig.timesupport.Time;
34 34
import org.gvsig.tools.dispose.Disposable;
35
import org.gvsig.tools.dynobject.DynObject;
35 36
import org.gvsig.tools.exception.BaseException;
36 37
import org.gvsig.tools.observer.ComplexWeakReferencingObservable;
37 38
import org.gvsig.tools.observer.Observer;
......
69 70

  
70 71
	/**
71 72
	 * Metadata property name for the provider name provided by the data provider.
72
	 * 
73
	 *
73 74
	 * This metadata is provided by all data providers.
74 75
	 */
75 76
	public static final String METADATA_PROVIDER = "ProviderName";
......
77 78
	/**
78 79
	 * Metadata property name for Container name provided by the data provider.
79 80
	 * By explample, in a dbf file, this is the name of dbf.
80
	 * 
81
	 *
81 82
	 * This metadata is provided by all data providers.
82 83
	 */
83 84
	public static final String METADATA_CONTAINERNAME = "ContainerName";
84 85

  
85 86
	/**
86 87
	 * Metadata property name for the feature type provided by the data provider.
87
	 * 
88
	 *
88 89
	 * This metadata is provided by all tabular data providers.
89 90
	 */
90 91
	public static final String METADATA_FEATURETYPE = "FeatureType";
91 92

  
92 93
	/**
93 94
	 * Metadata property name for CRS provided by the data provider.
94
	 * 
95
	 * This metadata is only provided by data provider with spatial 
95
	 *
96
	 * This metadata is only provided by data provider with spatial
96 97
	 * information.
97 98
	 */
98 99
	public static final String METADATA_CRS = "CRS";
99 100

  
100 101
	/**
101 102
	 * Metadata property name for Envelope provided by the data provider
102
	 * 
103
	 * This metadata is only provided by data provider with spatial 
103
	 *
104
	 * This metadata is only provided by data provider with spatial
104 105
	 * information.
105 106
	 */
106 107
	public static final String METADATA_ENVELOPE = "Envelope";
......
109 110
	 * Returns the name associated to the store.
110 111
	 * This name is provided for informational purposes only.
111 112
	 * Explamples:
112
	 * 
113
	 *
113 114
	 * In a dbf the filename without the path
114
	 * 
115
	 *
115 116
	 * In a DDBB table the name of the table
116
	 * 
117
	 *
117 118
	 * In a WFS layer the name of the layer.
118 119
	 *
119 120
	 * @return String containing this store's name.
120 121
	 */
121 122
	public String getName();
122
	
123

  
123 124
	/**
124 125
	 * Returns a more descriptive name for the store that getName.
125 126
	 * This name is provided for informational purposes only.
126 127
	 * Explamples:
127
	 * 
128
	 *
128 129
	 * In a file based store may return the full name of the filename, path and filename.
129
	 * 
130
	 *
130 131
	 * In a data base based store may return "server:dbname:tablename"
131
	 * 
132
	 *
132 133
	 * In a WFS layer based store may return "server:layername"
133
	 * 
134
	 *
134 135
	 * @return String Containing the full name of the store
135 136
	 */
136 137
	public String getFullName();
......
144 145

  
145 146
	/**
146 147
	 * Return the provider name that use this store.
147
	 * 
148
	 *
148 149
	 * @return provider name of this store
149 150
	 */
150 151
	public String getProviderName();
151
	
152

  
152 153
	/**
153 154
	 * Refreshes this store state.
154 155
	 *
......
182 183
     * The values received through the {@link Visitor#visit(Object)} method
183 184
     * may be transient, reused or externally modifiable, so they can't
184 185
     * be used to be stored in any external form out of the visit method.
185
     * 
186
     *
186 187
     * If you need to store any of the values out of the
187 188
     * {@link Visitor#visit(Object)} method execution, create a copy or clone
188 189
     * the received value in order to be stored.
189
     * 
190
     *
190 191
     * @param visitor
191 192
     *            the visitor to apply to each value.
192 193
     * @exception BaseException
......
199 200
     * The values received through the {@link Visitor#visit(Object)} method
200 201
     * may be transient, reused or externally modifiable, so they can't
201 202
     * be used to be stored in any external form out of the visit method.
202
     * 
203
     *
203 204
     * If you need to store any of the values out of the
204 205
     * {@link Visitor#visit(Object)} method execution, create a copy or clone
205 206
     * the received value in order to be stored.
206
     * 
207
     *
207 208
     * @param visitor
208 209
     *            the visitor to apply to each value.
209 210
     * @param dataQuery
......
274 275
	/**
275 276
	 * Returns the DataServerExplorer to which this DataStore belongs, if there
276 277
	 * is any.
277
	 * 
278
	 *
278 279
	 * @return DataServerExplorer to which this DataStore belongs, or
279 280
	 *         <code>null</code> if this was not accessed through any
280 281
	 *         DataServerExplorer.
281
	 * 
282
	 *
282 283
	 * @throws DataException
283 284
	 * @throws ValidateDataParametersException
284 285
	 */
......
294 295
	 * @throws DataException
295 296
	 */
296 297
	public DataQuery createQuery();
297
	
298

  
298 299
	/**
299 300
	 * Gets the {@link Interval} of the store, that means the temporal
300 301
	 * interval where the store has valid data.
......
302 303
	 *         a time interval or null if there is not time support
303 304
	 */
304 305
	public Interval getInterval();
305
	
306

  
306 307
	/**
307
	 * Gets all the possible values of time for which the store has data.  
308
	 * Gets all the possible values of time for which the store has data.
308 309
	 * @return
309 310
	 *         a collection of {@link Time} objects.
310 311
	 */
311 312
	public Collection getTimes();
312
	
313

  
313 314
	/**
314 315
	 * Gets all the possible values of time for which the store has data
315 316
	 * and intersects with an interval.
......
319 320
	 *         a collection of {@link Time} objects.
320 321
	 */
321 322
	public Collection getTimes(Interval interval);
323

  
324
	/**
325
	 * @param providerName
326
	 * @param parameters
327
	 * @throws DataException
328
	 */
329
	public void useCache(String providerName, DynObject parameters) throws DataException;
330

  
331
	public DataStoreProviderFactory getFactory();
322 332
}
323 333

  

Also available in: Unified diff