org.gvsig.fmap.dal.store.shp

Class SHPStoreProvider

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.dbf.DBFStoreProvider

org.gvsig.fmap.dal.store.shp.SHPStoreProvider

All Implemented Interfaces:

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

public class SHPStoreProvider
extends DBFStoreProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SHPStoreProvider.ReadGeometryException

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

AbstractFeatureStoreProvider.FeatureProviderNotFoundException

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DESCRIPTION
static java.lang.String	GEOMETRY_ATTIBUTE_NAME
static java.lang.String	METADATA_DEFINITION_NAME
static java.lang.String	NAME

Fields inherited from class org.gvsig.fmap.dal.store.dbf.DBFStoreProvider

featureType, MAX_FIELD_NAME_LENGTH

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

store

Constructor Summary

Constructors

Constructor and Description
SHPStoreProvider(SHPStoreParameters params, DataStoreProviderServices storeServices)

Method Summary

Modifier and Type	Method and Description
protected static EditableFeatureAttributeDescriptor	addGeometryColumn(EditableFeatureType fType)
boolean	allowWrite() Informs that store supports write.
void	append(FeatureProvider featureProvider) unsupported by default, override this otherwise
void	beginAppend() unsupported by default, override this otherwise
boolean	canWriteGeometry(int geometryType, int geometrySubType) unsupported geometry write by default (return false), override this otherwise
protected void	closeFile()
FeatureProvider	createFeatureProvider(FeatureType type) Default Factory of FeatureProvider.
FeatureProvider	createFeatureProvider(FeatureType providerFeatureType, FeatureType storeFeatureType)
protected void	disposeResource()
protected void	doDispose() Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.
void	endAppend() unsupported by default, override this otherwise
void	fixFeatureTypeFromParameters()
java.lang.Object	getDynValue(java.lang.String name)
Envelope	getEnvelope() unsupported geometry by default (return null), override this otherwise
protected FeatureProvider	getFeatureProviderByIndex(long index, FeatureType providerFeatureType, FeatureType storeFeatureType)
SHPStoreParameters	getParameters()
IProjection	getProjection()
java.lang.String	getProviderName() Return the name of the provider.
ResourceProvider	getResource() Returns the Resource from where the data is being loaded.
protected SHPStoreParameters	getShpParameters()
java.lang.Object	getSourceId() Returns the unique identifier of the Store FIXME add examples
protected EditableFeatureType	getTheFeatureType()
boolean	hasDynValue(java.lang.String name)
protected void	init(DBFStoreParameters params, DataStoreProviderServices storeServices)
protected void	initFeatureProviderByIndex(FeatureProvider featureProvider, long index, FeatureType featureType)
protected void	initResource(DBFStoreParameters params, DataStoreProviderServices storeServices)
protected void	loadFeatureProviderByIndex(FeatureProvider featureProvider)
protected void	loadValue(DBFFeatureProvider featureProvider, long rowIndex, FeatureAttributeDescriptor descriptor)
protected void	openFile()
void	performChanges(java.util.Iterator deleteds, java.util.Iterator inserteds, java.util.Iterator updateds, java.util.Iterator originalFeatureTypesUpdated) unsupported by default, override this otherwise
protected void	resourceCloseRequest()
protected void	resourcesNotifyChanges()
protected void	resourcesNotifyClose()
protected void	resourcesOpen()

Methods inherited from class org.gvsig.fmap.dal.store.dbf.DBFStoreProvider

canCreate, checkNewFieldsNameSize, close, closeResourceRequested, createNewOID, createSet, createSet, getDBFParameters, getExplorer, getFeatureCount, getFeatureProviderByIndex, getFullName, getName, getNewFieldsWithNameTooLong, getOIDType, initFeatureType, initResource, internalGetFeatureProviderByReference, open, refresh, registerMetadataDefinition, resourceChanged, setStoreFeatureType, supportsAppendMode

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

abortAppend, allowAutomaticValues, allowGeometry, beginAppend, clear, createExpression, createFeatureLocks, createFeatureSelection, createResource, delegate, getChildren, getDynClass, getEnvelope, getFeatureProviderByReference, getFeatureProviderByReference, getFeatureStore, getInterval, getResourcesStorage, getRetrievedFeaturesLimit, getStoreServices, getStoresRepository, getTimes, getTimes, hasDynMethod, hasRetrievedFeaturesLimit, implement, internalGetFeatureProviderByReference, invokeDynMethod, invokeDynMethod, isKnownEnvelope, isLocksSupported, isTemporary, passThroughDelete, passThroughDelete, passThroughInsert, passThroughInsertOrUpdate, passThroughUpdate, passThroughUpdate, savePrjFile, setDynValue, setMetadata, 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 java.lang.String NAME

DESCRIPTION

public static java.lang.String DESCRIPTION

GEOMETRY_ATTIBUTE_NAME

public static final java.lang.String GEOMETRY_ATTIBUTE_NAME

See Also:

Constant Field Values

METADATA_DEFINITION_NAME

public static final java.lang.String METADATA_DEFINITION_NAME

Constructor Detail

SHPStoreProvider

public SHPStoreProvider(SHPStoreParameters params,
                        DataStoreProviderServices storeServices)
                 throws InitializeException

Parameters:

params -

storeServices -

Throws:

InitializeException

Method Detail

init

protected void init(DBFStoreParameters params,
                    DataStoreProviderServices storeServices)
             throws InitializeException

Overrides:

init in class DBFStoreProvider

Throws:

InitializeException

getParameters

public SHPStoreParameters getParameters()

Specified by:

getParameters in interface FeatureStoreProvider

Overrides:

getParameters in class AbstractFeatureStoreProvider

Returns:

the parameters

getProjection

public IProjection getProjection()

getDynValue

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

Specified by:

getDynValue in interface DynObject

Overrides:

getDynValue in class DBFStoreProvider

Throws:

DynFieldNotFoundException

hasDynValue

public boolean hasDynValue(java.lang.String name)
                    throws DynFieldNotFoundException

Specified by:

hasDynValue in interface DynObject

Overrides:

hasDynValue in class AbstractFeatureStoreProvider

Throws:

DynFieldNotFoundException

initResource

protected void initResource(DBFStoreParameters params,
                            DataStoreProviderServices storeServices)
                     throws InitializeException

Overrides:

initResource in class DBFStoreProvider

Throws:

InitializeException

getResource

public ResourceProvider getResource()

Description copied from interface: DataStoreProvider

Returns the Resource from where the data is being loaded.

Overrides:

getResource in class DBFStoreProvider

Returns:

the data Resource

resourcesNotifyChanges

protected void resourcesNotifyChanges()
                               throws ResourceNotifyChangesException

Overrides:

resourcesNotifyChanges in class DBFStoreProvider

Throws:

ResourceNotifyChangesException

resourcesNotifyClose

protected void resourcesNotifyClose()
                             throws ResourceNotifyCloseException

Overrides:

resourcesNotifyClose in class DBFStoreProvider

Throws:

ResourceNotifyCloseException

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 DBFStoreProvider

Throws:

BaseException

See Also:

AbstractDisposable.dispose()

disposeResource

protected void disposeResource()

Overrides:

disposeResource in class DBFStoreProvider

resourcesOpen

protected void resourcesOpen()
                      throws ResourceNotifyOpenException

Overrides:

resourcesOpen in class DBFStoreProvider

Throws:

ResourceNotifyOpenException

addGeometryColumn

protected static EditableFeatureAttributeDescriptor addGeometryColumn(EditableFeatureType fType)

getTheFeatureType

protected EditableFeatureType getTheFeatureType()
                                         throws InitializeException

Overrides:

getTheFeatureType in class DBFStoreProvider

Throws:

InitializeException

getShpParameters

protected SHPStoreParameters getShpParameters()

getProviderName

public java.lang.String getProviderName()

Description copied from interface: DataStoreProvider

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

Overrides:

getProviderName in class DBFStoreProvider

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 DBFStoreProvider

Returns:

true if write is supported

getFeatureProviderByIndex

protected FeatureProvider getFeatureProviderByIndex(long index,
                                                    FeatureType providerFeatureType,
                                                    FeatureType storeFeatureType)
                                             throws DataException

Overrides:

getFeatureProviderByIndex in class DBFStoreProvider

Parameters:

index -

providerFeatureType -

Returns:

Throws:

ReadException

DataException

initFeatureProviderByIndex

protected void initFeatureProviderByIndex(FeatureProvider featureProvider,
                                          long index,
                                          FeatureType featureType)
                                   throws DataException

Overrides:

initFeatureProviderByIndex in class DBFStoreProvider

Throws:

DataException

loadFeatureProviderByIndex

protected void loadFeatureProviderByIndex(FeatureProvider featureProvider)
                                   throws DataException

Overrides:

loadFeatureProviderByIndex in class DBFStoreProvider

Parameters:

featureProvider -

Throws:

DataException

loadValue

protected void loadValue(DBFFeatureProvider featureProvider,
                         long rowIndex,
                         FeatureAttributeDescriptor descriptor)
                  throws ReadException

Overrides:

loadValue in class DBFStoreProvider

Throws:

ReadException

createFeatureProvider

public FeatureProvider createFeatureProvider(FeatureType type)
                                      throws DataException

Description copied from class: AbstractFeatureStoreProvider

Default Factory of FeatureProvider. Create a new default FeatureProvider instance.
Override this if you need an special implemtation of FeatureProvider.

Specified by:

createFeatureProvider in interface FeatureStoreProvider

Overrides:

createFeatureProvider in class DBFStoreProvider

Returns:

Throws:

DataException

See Also:

org.gvsig.fmap.dal.feature.spi.FeatureStoreProvider#createFeatureProvider(FeatureType)}

createFeatureProvider

public FeatureProvider createFeatureProvider(FeatureType providerFeatureType,
                                             FeatureType storeFeatureType)
                                      throws DataException

Overrides:

createFeatureProvider in class DBFStoreProvider

Throws:

DataException

openFile

protected void openFile()
                 throws java.io.IOException,
                        DataException

Overrides:

openFile in class DBFStoreProvider

Throws:

java.io.IOException

DataException

closeFile

protected void closeFile()
                  throws CloseException

Overrides:

closeFile in class DBFStoreProvider

Throws:

CloseException

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 DBFStoreProvider

Returns:

Throws:

DataException

See Also:

FeatureStoreProvider.canWriteGeometry(int, int)

performChanges

public void performChanges(java.util.Iterator deleteds,
                           java.util.Iterator inserteds,
                           java.util.Iterator updateds,
                           java.util.Iterator originalFeatureTypesUpdated)
                    throws PerformEditingException

Description copied from class: AbstractFeatureStoreProvider

unsupported by default, override this otherwise

Specified by:

performChanges in interface FeatureStoreProvider

Overrides:

performChanges in class DBFStoreProvider

Parameters:

deleteds - iterator of FeatureReferenceProviderServices

inserteds - iterator of FeatureProvider

updateds - iterator of FeatureProvider

originalFeatureTypesUpdated - iterator of FeatureType.FeatureTypeChanged

Throws:

PerformEditingException

See Also:

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

resourceCloseRequest

protected void resourceCloseRequest()
                             throws ResourceException

Overrides:

resourceCloseRequest in class DBFStoreProvider

Throws:

ResourceException

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

append

public void append(FeatureProvider featureProvider)
            throws DataException

Description copied from class: AbstractFeatureStoreProvider

unsupported by default, override this otherwise

Specified by:

append in interface FeatureStoreProvider

Overrides:

append in class DBFStoreProvider

Throws:

DataException

See Also:

org.gvsig.fmap.dal.feature.spi.FeatureStoreProvider#append(org.gvsig. fmap.dal.feature.spi.FeatureProvider)

beginAppend

public void beginAppend()
                 throws DataException

Description copied from class: AbstractFeatureStoreProvider

unsupported by default, override this otherwise

Specified by:

beginAppend in interface FeatureStoreProvider

Overrides:

beginAppend in class DBFStoreProvider

Throws:

DataException

See Also:

FeatureStoreProvider.beginAppend()

endAppend

public void endAppend()
               throws DataException

Description copied from class: AbstractFeatureStoreProvider

unsupported by default, override this otherwise

Specified by:

endAppend in interface FeatureStoreProvider

Overrides:

endAppend in class DBFStoreProvider

Throws:

DataException

See Also:

FeatureStoreProvider.endAppend()

getSourceId

public java.lang.Object getSourceId()

Description copied from interface: DataStoreProvider

Returns the unique identifier of the Store FIXME add examples

Overrides:

getSourceId in class DBFStoreProvider

Returns:

fixFeatureTypeFromParameters

public void fixFeatureTypeFromParameters()

Specified by:

fixFeatureTypeFromParameters in interface FeatureStoreProvider

Overrides:

fixFeatureTypeFromParameters in class DBFStoreProvider