Package org.gvsig.fmap.dal.spi

Interface DataStoreProvider

All Superinterfaces:
org.gvsig.fmap.dal.DataFactoryUnit, org.gvsig.fmap.dal.DataStoreProvider, org.gvsig.tools.dispose.Disposable, org.gvsig.tools.dynobject.DynObject, org.gvsig.tools.dynobject.DynObject_v2
All Known Subinterfaces:
CoverageStoreProvider, FeatureCacheProvider, FeatureStoreProvider, FeatureStoreProvider_v2, RasterCacheStoreProvider, RasterStoreProvider
All Known Implementing Classes:
AbstractAwtRasterStoreProvider, AbstractCoverageStoreProvider, AbstractDataStoreProvider, AbstractFeatureStoreProvider, AbstractMemoryStoreProvider, AbstractRasterStoreProvider
public interface DataStoreProvider extends org.gvsig.fmap.dal.DataStoreProvider, org.gvsig.tools.dynobject.DynObject_v2, org.gvsig.tools.dispose.Disposable
Base interface for all data providers
Author:
jmvivo

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Request to close de source
    org.gvsig.tools.util.UnmodifiableBasicMap<String,org.gvsig.fmap.dal.DataStore>
    getChildren()
    Returns an UnmodifiableBasicMap with subStores from this store.
    org.gvsig.fmap.dal.DataServerExplorer
    getExplorer()
    Create a DataServerExplorer from the same source that this store.
    String
    getFullName()
    Returns a more descriptive name for the provider that getName.
    org.gvsig.timesupport.Interval
    getInterval()
    Gets the Interval of the store, that means the temporal interval where the store has valid data.
    String
    getName()
    Returns the name associated to the provider.
    String
    getProviderName()
    Return the name of the provider.
    org.gvsig.fmap.dal.resource.spi.ResourceProvider
    getResource()
    Returns the Resource from where the data is being loaded.
    org.gvsig.tools.resourcesstorage.ResourcesStorage
    getResourcesStorage()
    Returns the resource store associated with this provider.
    Object
    getSourceId()
    Returns the unique identifier of the Store FIXME add examples
    org.gvsig.fmap.dal.StoresRepository
    getStoresRepository()
     
    Collection
    getTimes()
    Gets all the possible values of time for which the store has data.
    Collection
    getTimes(org.gvsig.timesupport.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(org.gvsig.fmap.dal.spi.DataTransactionServices transaction)
     

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

    dispose

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

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

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

    hasDynMethod

  • Method Details

    • getChildren

      org.gvsig.tools.util.UnmodifiableBasicMap<String,org.gvsig.fmap.dal.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

      org.gvsig.fmap.dal.StoresRepository getStoresRepository()

    • getResourcesStorage

      org.gvsig.tools.resourcesstorage.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

      org.gvsig.fmap.dal.DataServerExplorer getExplorer() throws org.gvsig.fmap.dal.exception.ReadException, org.gvsig.fmap.dal.exception.ValidateDataParametersException
      Create a DataServerExplorer from the same source that this store.
      Returns:
      ServerExplorer
      Throws:
      org.gvsig.fmap.dal.exception.ReadException
      org.gvsig.fmap.dal.exception.ValidateDataParametersException

    • open

      void open() throws org.gvsig.fmap.dal.exception.OpenException
      Open store. You must call it before do anything whith store.
      This method can be called repeatly.
      Throws:
      org.gvsig.fmap.dal.exception.OpenException

    • close

      void close() throws org.gvsig.fmap.dal.exception.CloseException
      Request to close de source
      Throws:
      org.gvsig.fmap.dal.exception.CloseException

    • getResource

      org.gvsig.fmap.dal.resource.spi.ResourceProvider getResource()
      Returns the Resource from where the data is being loaded.
      Returns:
      the data Resource

    • refresh

      void refresh() throws org.gvsig.fmap.dal.exception.OpenException, org.gvsig.fmap.dal.exception.InitializeException
      Force to reload information of Store
      Throws:
      org.gvsig.fmap.dal.exception.OpenException
      org.gvsig.fmap.dal.exception.InitializeException

    • getSourceId

      Object getSourceId()
      Returns the unique identifier of the Store FIXME add examples
      Returns:

    • getProviderName

      String getProviderName()
      Return the name of the provider. Examples: dbf, shp, jdbc, postgresql, wfs, gml
      Returns:

    • getName

      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

      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

      org.gvsig.timesupport.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

      Collection getTimes()
      Gets all the possible values of time for which the store has data.
      Returns:
      a collection of Time objects.

    • getTimes

      Collection getTimes(org.gvsig.timesupport.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(org.gvsig.fmap.dal.spi.DataTransactionServices transaction)