org.gvsig.fmap.dal.spi

Interface DataStoreProvider

All Superinterfaces:

DataFactoryUnit, DataStoreProvider, Disposable, DynObject, DynObject_v2

All Known Subinterfaces:

CoverageStoreProvider, FeatureCacheProvider, FeatureStoreProvider, FeatureStoreProvider_v2, JDBCStoreProvider, RasterCacheStoreProvider, RasterProvider, RasterStoreProvider, RemoteRasterProvider

All Known Implementing Classes:

AbstractAwtRasterStoreProvider, AbstractCoverageStoreProvider, AbstractFeatureStoreProvider, AbstractFileRasterStoreProvider, AbstractMemoryStoreProvider, AbstractRasterProvider, AbstractRasterStoreProvider, AbstractTileCacheStoreProvider, BingMapsProvider, BSQStoreProvider, CSVStoreProvider, DBFStoreProvider, DGNStoreProvider, DWGStoreProvider, DXFStoreProvider, ErmapperProvider, FeatureTypeToStoreProviderAdapter, GdalProvider, GMLDataStoreProvider, GMLStoreProvider, GoogleMapsProvider, GPEStoreProvider, ImageIOStoreProvider, JDBCStoreProviderBase, JExcelStoreProvider, JsonStoreProvider, KMLStoreProvider, LizardTechProvider, MemoryRasterProvider, MemoryStoreProvider, MemoryTileCacheStoreProvider, MultiFileProvider, NetCDFProvider, OGRDataStoreProvider, OGRStoreProvider, OSMProvider, PostGISRasterProvider, SeismicStoreProvider, SHPStoreProvider, SimpleReaderStoreProvider, SimpleSequentialReaderStoreProvider, TileCacheStoreProvider, TileFileFormatProvider, TileProvider, WCSProvider, WFSStoreProvider, WMSProvider, WMTSProvider

public interface DataStoreProvider
extends DataStoreProvider, DynObject_v2, Disposable

Base interface for all data providers

Method Summary

Modifier and Type	Method and Description
void	close() Request to close de source
UnmodifiableBasicMap<java.lang.String,DataStore>	getChildren() Returns an UnmodifiableBasicMap with subStores from this store.
DataServerExplorer	getExplorer() Create a DataServerExplorer from the same source that this store.
java.lang.String	getFullName() Returns a more descriptive name for the provider that getName.
Interval	getInterval() Gets the Interval of the store, that means the temporal interval where the store has valid data.
java.lang.String	getName() Returns the name associated to the provider.
java.lang.String	getProviderName() Return the name of the provider.
ResourceProvider	getResource() Returns the Resource from where the data is being loaded.
ResourcesStorage	getResourcesStorage() Returns the resource store associated with this provider.
java.lang.Object	getSourceId() Returns the unique identifier of the Store FIXME add examples
StoresRepository	getStoresRepository()
java.util.Collection	getTimes() Gets all the possible values of time for which the store has data.
java.util.Collection	getTimes(Interval interval) Gets all the possible values of time for which the store has data and intersects with an interval.
void	open() Open store.
void	refresh() Force to reload information of Store
void	setTransaction(DataTransactionServices transaction)

Methods inherited from interface org.gvsig.tools.dynobject.DynObject_v2

hasDynMethod

Methods inherited from interface org.gvsig.tools.dynobject.DynObject

clear, clone, delegate, getDynClass, getDynValue, hasDynValue, implement, invokeDynMethod, invokeDynMethod, setDynValue

Methods inherited from interface org.gvsig.tools.dispose.Disposable

dispose

Method Detail

getChildren

UnmodifiableBasicMap<java.lang.String,DataStore> getChildren()

Returns an UnmodifiableBasicMap with subStores from this store. If do not have children, return an empty UnmodifiableBasicMap. Never returns null.

Returns:

SubStores UnmodifiableBasicMap

getStoresRepository

StoresRepository getStoresRepository()

getResourcesStorage

ResourcesStorage getResourcesStorage()

Returns the resource store associated with this provider. If one does not exist, it will return null.

Returns:

the ResourcesStorage or null.

getExplorer

DataServerExplorer getExplorer()
                        throws ReadException,
                               ValidateDataParametersException

Create a DataServerExplorer from the same source that this store.

Returns:

ServerExplorer

Throws:

ReadException

ValidateDataParametersException

open

void open()
   throws OpenException

Open store. You must call it before do anything whith store.
This method can be called repeatly.

Throws:

OpenException

close

void close()
    throws CloseException

Request to close de source

Throws:

CloseException

getResource

ResourceProvider getResource()

Returns the Resource from where the data is being loaded.

Returns:

the data Resource

refresh

void refresh()
      throws OpenException,
             InitializeException

Force to reload information of Store

Throws:

OpenException

InitializeException

getSourceId

java.lang.Object getSourceId()

Returns the unique identifier of the Store FIXME add examples

Returns:

getProviderName

java.lang.String getProviderName()

Return the name of the provider. Examples: dbf, shp, jdbc, postgresql, wfs, gml

Returns:

getName

java.lang.String getName()

Returns the name associated to the provider. This name is provided for informational purposes only. Explamples: In a dbf the filename without the path In a DDBB table the name of the table In a WFS layer the name of the layer.

Returns:

String containing this store's name.

getFullName

java.lang.String getFullName()

Returns a more descriptive name for the provider that getName. This name is provided for informational purposes only. Explamples: In a file based store may return the full name of the filename, path and filename. In a data base based store may return "server:dbname:tablename" In a WFS layer based store may return "server:layername"

Returns:

String Containing the full name of the store

getInterval

Interval getInterval()

Gets the Interval of the store, that means the temporal interval where the store has valid data.

Returns:

a time interval or null if there is not time support

getTimes

java.util.Collection getTimes()

Gets all the possible values of time for which the store has data.

Returns:

a collection of Time objects.

getTimes

java.util.Collection getTimes(Interval interval)

Gets all the possible values of time for which the store has data and intersects with an interval.

Parameters:

interval - the interval of time

Returns:

a collection of Time objects.

setTransaction

void setTransaction(DataTransactionServices transaction)