org.gvsig.fmap.dal.store.gpe

Class GPEStoreProvider

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

org.gvsig.fmap.dal.spi.AbstractDataStoreProvider

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

org.gvsig.fmap.dal.store.gpe.GPEStoreProvider

All Implemented Interfaces:

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

public class GPEStoreProvider
extends AbstractFeatureStoreProvider
implements 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 FmapContentHandler	contentHandler
static java.lang.String	DESCRIPTION
protected FmapErrorHandler	errorHandler
protected GPEManager	gpeManager
protected boolean	isOpen
protected java.io.File	m_Fich
static java.lang.String	METADATA_DEFINITION_NAME
static java.lang.String	NAME
protected XMLSchemaManager	xmlSchemaManager

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

store

Constructor Summary

Constructors

Modifier	Constructor and Description
	GPEStoreProvider(DataStoreParameters params, DataStoreProviderServices storeServices)
protected	GPEStoreProvider(DataStoreParameters params, DataStoreProviderServices storeServices, DynObject metadata)

Method Summary

Modifier and Type	Method and Description
boolean	canWriteGeometry(int geometryType, int geometrySubtype) unsupported geometry write by default (return false), override this otherwise
boolean	closeResourceRequested(ResourceProvider resource)
java.lang.Object	createNewOID() Return a new OID valid for a new feature.
FeatureSetProvider	createSet(FeatureQuery query)
FeatureSetProvider	createSet(FeatureQuery query, FeatureType featureType) Factory of FeatureSetProvider.
FmapContentHandler	getContentHandler()
java.lang.Object	getDynValue(java.lang.String name)
Envelope	getEnvelope() unsupported geometry by default (return null), override this otherwise
FmapErrorHandler	getErrorHandler()
DataServerExplorer	getExplorer() unsupported 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 int	getGeometryType()
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 IProjection	getSRS()
protected void	initFeatureType()
protected FeatureProvider	internalGetFeatureProviderByReference(FeatureReferenceProviderServices reference) Returns a FeatureProvider by reference, using the default FeatureType.
FeatureProvider	internalGetFeatureProviderByReference(FeatureReferenceProviderServices reference, FeatureType featureType) Returns a FeatureProvider by reference, using the provided FeatureType.
void	open() Open store.
void	resourceChanged(ResourceProvider resource)
void	resourcesBegin()
void	resourcesEnd()
protected void	retrieveFile()
void	setEnvelope(Envelope envelope)

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

abortAppend, allowAutomaticValues, allowGeometry, allowWrite, append, beginAppend, beginAppend, clear, close, createExpression, createFeatureLocks, createFeatureProvider, createFeatureSelection, createResource, createSet, delegate, doDispose, endAppend, fixFeatureTypeFromParameters, getChildren, getDynClass, getEnvelope, getFeatureProviderByReference, getFeatureProviderByReference, getFeatureStore, getInterval, getParameters, getResourcesStorage, getRetrievedFeaturesLimit, getStoreServices, getStoresRepository, getTimes, getTimes, hasDynMethod, hasDynValue, hasRetrievedFeaturesLimit, implement, invokeDynMethod, invokeDynMethod, isKnownEnvelope, isLocksSupported, isTemporary, passThroughDelete, passThroughDelete, passThroughInsert, passThroughInsertOrUpdate, passThroughUpdate, passThroughUpdate, performChanges, 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.spi.DataStoreProvider

setTransaction

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

clone

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

dispose

Field Detail

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

METADATA_DEFINITION_NAME

public static final java.lang.String METADATA_DEFINITION_NAME

See Also:

Constant Field Values

m_Fich

protected java.io.File m_Fich

isOpen

protected boolean isOpen

gpeManager

protected GPEManager gpeManager

xmlSchemaManager

protected XMLSchemaManager xmlSchemaManager

contentHandler

protected FmapContentHandler contentHandler

errorHandler

protected FmapErrorHandler errorHandler

Constructor Detail

GPEStoreProvider

public GPEStoreProvider(DataStoreParameters params,
                        DataStoreProviderServices storeServices)
                 throws InitializeException

Throws:

InitializeException

GPEStoreProvider

protected GPEStoreProvider(DataStoreParameters params,
                           DataStoreProviderServices storeServices,
                           DynObject metadata)
                    throws InitializeException

Throws:

InitializeException

Method Detail

retrieveFile

protected void retrieveFile()
                     throws InitializeException

Throws:

InitializeException

initFeatureType

protected void initFeatureType()
                        throws InitializeException

Throws:

InitializeException

getDynValue

public java.lang.Object getDynValue(java.lang.String name)
                             throws DynFieldNotFoundException

Specified by:

getDynValue in interface DynObject

Overrides:

getDynValue in class AbstractFeatureStoreProvider

Throws:

DynFieldNotFoundException

closeResourceRequested

public boolean closeResourceRequested(ResourceProvider resource)

Specified by:

closeResourceRequested in interface ResourceConsumer

resourceChanged

public void resourceChanged(ResourceProvider resource)

Specified by:

resourceChanged in interface ResourceConsumer

canWriteGeometry

public boolean canWriteGeometry(int geometryType,
                                int geometrySubtype)
                         throws DataException

Description copied from class: AbstractFeatureStoreProvider

unsupported geometry write by default (return false), override this otherwise

Specified by:

canWriteGeometry in interface FeatureStoreProvider

Overrides:

canWriteGeometry in class AbstractFeatureStoreProvider

Returns:

Throws:

DataException

See Also:

FeatureStoreProvider.canWriteGeometry(int, int)

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)
                             throws DataException

Throws:

DataException

internalGetFeatureProviderByReference

protected FeatureProvider internalGetFeatureProviderByReference(FeatureReferenceProviderServices reference)
                                                         throws DataException

Description copied from class: AbstractFeatureStoreProvider

Returns a FeatureProvider by reference, using the default FeatureType. This method may be rewritten by the child classes as an implementation of the AbstractFeatureStoreProvider.getFeatureProviderByReference(FeatureReferenceProviderServices) method.

Overrides:

internalGetFeatureProviderByReference in class AbstractFeatureStoreProvider

Parameters:

reference - the reference to the FeatureProvider

Returns:

the FeatureProvider being referenced

Throws:

DataException - if there is an error loading the FeatureProvider

internalGetFeatureProviderByReference

public FeatureProvider internalGetFeatureProviderByReference(FeatureReferenceProviderServices reference,
                                                             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:

reference - 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

resourcesBegin

public void resourcesBegin()
                    throws ResourceExecuteException

Throws:

ResourceExecuteException

resourcesEnd

public void resourcesEnd()

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}

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:

getSourceId

public java.lang.Object getSourceId()

Description copied from interface: DataStoreProvider

Returns the unique identifier of the Store FIXME add examples

Returns:

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.

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

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

getSRS

protected IProjection getSRS()

getGeometryType

protected int getGeometryType()

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

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()

setEnvelope

public void setEnvelope(Envelope envelope)

getResource

public ResourceProvider getResource()

Description copied from interface: DataStoreProvider

Returns the Resource from where the data is being loaded.

Returns:

the data Resource

getExplorer

public DataServerExplorer getExplorer()
                               throws ReadException,
                                      ValidateDataParametersException

Description copied from class: AbstractFeatureStoreProvider

unsupported by default (return null), override this otherwise

Overrides:

getExplorer in class AbstractFeatureStoreProvider

Returns:

ServerExplorer

Throws:

ReadException

ValidateDataParametersException

See Also:

DataStoreProvider.getExplorer()

getContentHandler

public FmapContentHandler getContentHandler()

Returns:

the contentHandler

getErrorHandler

public FmapErrorHandler getErrorHandler()

Returns:

the errorHandler