org.gvsig.gdal.prov.ogr

Class OGRDataStoreProvider

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

org.gvsig.fmap.dal.spi.AbstractDataStoreProvider

org.gvsig.fmap.dal.feature.spi.AbstractFeatureStoreProvider

org.gvsig.gdal.prov.ogr.OGRDataStoreProvider

All Implemented Interfaces:

DataFactoryUnit, DataStoreProvider, FeatureStoreProvider, FeatureStoreProvider_v2, ResourceConsumer, Disposable, DynObject, DynObject_v2

Direct Known Subclasses:

GMLDataStoreProvider, KMLStoreProvider

public class OGRDataStoreProvider
extends AbstractFeatureStoreProvider
implements FeatureStoreProvider, ResourceConsumer

Nested Class Summary

Nested classes/interfaces inherited from class org.gvsig.fmap.dal.feature.spi.AbstractFeatureStoreProvider

AbstractFeatureStoreProvider.FeatureProviderNotFoundException

Field Summary

Fields

Modifier and Type	Field and Description
protected DataSource	dataSource
static java.lang.String	DESCRIPTION
protected static Logger	LOG
static java.lang.String	METADATA_DEFINITION_NAME
static java.lang.String	NAME
protected ResourceProvider	resourceProvider

Fields inherited from class org.gvsig.fmap.dal.feature.spi.AbstractFeatureStoreProvider

store

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OGRDataStoreProvider(DataStoreParameters dataParameters, DataStoreProviderServices storeServices)
protected	OGRDataStoreProvider(DataStoreParameters dataParameters, DataStoreProviderServices storeServices, DynObject metadata)

Method Summary

Modifier and Type	Method and Description
boolean	allowWrite() Informs that store supports write.
boolean	closeResourceRequested(ResourceProvider resource)
protected java.lang.String	compoundSelect(FeatureType type, Evaluator evaluator, FeatureQueryOrder featureQueryOrder)
java.lang.Object	createNewOID() Return a new OID valid for a new feature.
FeatureSetProvider	createSet(FeatureQuery query, FeatureType featureType) Factory of FeatureSetProvider.
protected void	doDispose() Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.
protected DataSource	getDataSource()
Envelope	getEnvelope() unsupported geometry by default (return null), override this otherwise
long	getFeatureCount() Returns total feature count of this store.
java.lang.String	getFullName() Returns a more descriptive name for the provider that getName.
protected Layer	getLayer()
java.lang.String	getName() Returns the name associated to the provider.
int	getOIDType() Return OID data type (from DataTypes) of this store.
java.lang.String	getProviderName() Return the name of the provider.
ResourceProvider	getResource() Returns the Resource from where the data is being loaded.
java.lang.Object	getSourceId() Returns the unique identifier of the Store FIXME add examples
protected FeatureProvider	internalGetFeatureProviderByReference(FeatureReferenceProviderServices providerServices, FeatureType featureType) Returns a FeatureProvider by reference, using the provided FeatureType.
protected boolean	loadFeatureType()
void	open() Open store.
void	performChanges(java.util.Iterator deleteds, java.util.Iterator inserteds, java.util.Iterator updateds, java.util.Iterator featureTypesChanged) unsupported by default, override this otherwise
protected void	repack()
void	resourceChanged(ResourceProvider resource)

Methods inherited from class org.gvsig.fmap.dal.feature.spi.AbstractFeatureStoreProvider

abortAppend, allowAutomaticValues, allowGeometry, append, beginAppend, beginAppend, canWriteGeometry, clear, close, createExpression, createFeatureLocks, createFeatureProvider, createFeatureSelection, createResource, createSet, delegate, endAppend, fixFeatureTypeFromParameters, getChildren, getDynClass, getDynValue, getEnvelope, getExplorer, getFeatureProviderByReference, getFeatureProviderByReference, getFeatureStore, getInterval, getParameters, getResourcesStorage, getRetrievedFeaturesLimit, getStoreServices, getStoresRepository, getTimes, getTimes, hasDynMethod, hasDynValue, hasRetrievedFeaturesLimit, implement, internalGetFeatureProviderByReference, invokeDynMethod, invokeDynMethod, isKnownEnvelope, isLocksSupported, isTemporary, passThroughDelete, passThroughDelete, passThroughInsert, passThroughInsertOrUpdate, passThroughUpdate, passThroughUpdate, refresh, savePrjFile, setDynValue, setMetadata, supportsAppendMode, supportsPassThroughMode, toString

Methods inherited from class org.gvsig.fmap.dal.spi.AbstractDataStoreProvider

setTransaction

Methods inherited from class org.gvsig.tools.dispose.impl.AbstractDisposable

dispose, dispose

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gvsig.fmap.dal.feature.spi.FeatureStoreProvider

abortAppend, allowAutomaticValues, allowGeometry, append, beginAppend, beginAppend, canWriteGeometry, createFeatureLocks, createFeatureProvider, createFeatureSelection, createSet, endAppend, fixFeatureTypeFromParameters, getEnvelope, getFeatureProviderByReference, getFeatureProviderByReference, getFeatureStore, getParameters, getRetrievedFeaturesLimit, getStoreServices, hasRetrievedFeaturesLimit, isKnownEnvelope, isLocksSupported, isTemporary, passThroughDelete, passThroughDelete, passThroughInsert, passThroughInsertOrUpdate, passThroughUpdate, passThroughUpdate, supportsAppendMode, supportsPassThroughMode

Methods inherited from interface org.gvsig.fmap.dal.spi.DataStoreProvider

close, getChildren, getExplorer, getInterval, getResourcesStorage, getStoresRepository, getTimes, getTimes, refresh, setTransaction

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

Field Detail

LOG

protected static final Logger LOG

METADATA_DEFINITION_NAME

public static final java.lang.String METADATA_DEFINITION_NAME

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

dataSource

protected DataSource dataSource

resourceProvider

protected ResourceProvider resourceProvider

Constructor Detail

OGRDataStoreProvider

protected OGRDataStoreProvider(DataStoreParameters dataParameters,
                               DataStoreProviderServices storeServices,
                               DynObject metadata)
                        throws InitializeException

Throws:

InitializeException

OGRDataStoreProvider

protected OGRDataStoreProvider(DataStoreParameters dataParameters,
                               DataStoreProviderServices storeServices)
                        throws InitializeException

Throws:

InitializeException

Method Detail

getDataSource

protected DataSource getDataSource()
                            throws OGRUnsupportedFormatException

Throws:

OGRUnsupportedFormatException

getLayer

protected Layer getLayer()
                  throws OGRUnsupportedFormatException

Throws:

OGRUnsupportedFormatException

getEnvelope

public Envelope getEnvelope()
                     throws DataException

Description copied from class: AbstractFeatureStoreProvider

unsupported geometry by default (return null), override this otherwise

Specified by:

getEnvelope in interface FeatureStoreProvider

Overrides:

getEnvelope in class AbstractFeatureStoreProvider

Returns:

this store's total envelope (extent) or null if store not have geometry information

Throws:

DataException

See Also:

FeatureStoreProvider.getEnvelope()

getFullName

public java.lang.String getFullName()

Description copied from interface: DataStoreProvider

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

getName

public java.lang.String getName()

Description copied from interface: DataStoreProvider

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.

getProviderName

public java.lang.String getProviderName()

Description copied from interface: DataStoreProvider

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

Returns:

allowWrite

public boolean allowWrite()

Description copied from interface: FeatureStoreProvider

Informs that store supports write.

Specified by:

allowWrite in interface FeatureStoreProvider

Overrides:

allowWrite in class AbstractFeatureStoreProvider

Returns:

true if write is supported

getResource

public ResourceProvider getResource()

Description copied from interface: DataStoreProvider

Returns the Resource from where the data is being loaded.

Returns:

the data Resource

getSourceId

public java.lang.Object getSourceId()

Description copied from interface: DataStoreProvider

Returns the unique identifier of the Store FIXME add examples

Returns:

open

public void open()
          throws OpenException

Description copied from interface: DataStoreProvider

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

Throws:

OpenException

loadFeatureType

protected boolean loadFeatureType()
                           throws OGRUnsupportedFormatException,
                                  GeometryTypeNotSupportedException,
                                  GeometryTypeNotValidException

Throws:

OGRUnsupportedFormatException

GeometryTypeNotSupportedException

GeometryTypeNotValidException

performChanges

public void performChanges(java.util.Iterator deleteds,
                           java.util.Iterator inserteds,
                           java.util.Iterator updateds,
                           java.util.Iterator featureTypesChanged)
                    throws DataException

Description copied from class: AbstractFeatureStoreProvider

unsupported by default, override this otherwise

Specified by:

performChanges in interface FeatureStoreProvider

Overrides:

performChanges in class AbstractFeatureStoreProvider

Parameters:

deleteds - iterator of FeatureReferenceProviderServices

inserteds - iterator of FeatureProvider

updateds - iterator of FeatureProvider

featureTypesChanged - iterator of FeatureType.FeatureTypeChanged

Throws:

DataException

See Also:

FeatureStoreProvider.performChanges(Iterator, Iterator, Iterator, Iterator)

repack

protected void repack()
               throws OGRUnsupportedFormatException

Throws:

OGRUnsupportedFormatException

createNewOID

public java.lang.Object createNewOID()

Description copied from interface: FeatureStoreProvider

Return a new OID valid for a new feature.

Specified by:

createNewOID in interface FeatureStoreProvider

Returns:

a new OID

See Also:

FeatureStoreProvider#getOIDType()}

createSet

public FeatureSetProvider createSet(FeatureQuery query,
                                    FeatureType featureType)
                             throws DataException

Description copied from interface: FeatureStoreProvider

Factory of FeatureSetProvider. Create a new FeatureSetProvider that represents result of FeatureQuery .

Specified by:

createSet in interface FeatureStoreProvider

Parameters:

query - (never will be null)

featureType - (never will be null)

Returns:

Throws:

DataException

getFeatureCount

public long getFeatureCount()
                     throws DataException

Description copied from interface: FeatureStoreProvider

Returns total feature count of this store.

Specified by:

getFeatureCount in interface FeatureStoreProvider

Returns:

Throws:

DataException

getOIDType

public int getOIDType()

Description copied from interface: FeatureStoreProvider

Return OID data type (from DataTypes) of this store.

Specified by:

getOIDType in interface FeatureStoreProvider

Returns:

OID data type

See Also:

FeatureStoreProvider#createNewOID()} {@link DataTypes}

internalGetFeatureProviderByReference

protected FeatureProvider internalGetFeatureProviderByReference(FeatureReferenceProviderServices providerServices,
                                                                FeatureType featureType)
                                                         throws DataException

Description copied from class: AbstractFeatureStoreProvider

Returns a FeatureProvider by reference, using the provided FeatureType. This is the child classes implementation of the AbstractFeatureStoreProvider.getFeatureProviderByReference(FeatureReferenceProviderServices) method.

Specified by:

internalGetFeatureProviderByReference in class AbstractFeatureStoreProvider

Parameters:

providerServices - the reference to the FeatureProvider

featureType - the type of feature to load

Returns:

the FeatureProvider being referenced

Throws:

DataException - if there is an error loading the FeatureProvider

compoundSelect

protected java.lang.String compoundSelect(FeatureType type,
                                          Evaluator evaluator,
                                          FeatureQueryOrder featureQueryOrder)

doDispose

protected void doDispose()
                  throws BaseException

Description copied from class: AbstractDisposable

Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.

Overrides:

doDispose in class AbstractFeatureStoreProvider

Throws:

BaseException

See Also:

AbstractDisposable.dispose()

closeResourceRequested

public boolean closeResourceRequested(ResourceProvider resource)

Specified by:

closeResourceRequested in interface ResourceConsumer

resourceChanged

public void resourceChanged(ResourceProvider resource)

Specified by:

resourceChanged in interface ResourceConsumer