org.gvsig.fmap.dal.store.dbf

Class DBFStoreProvider

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

All Implemented Interfaces:

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

Direct Known Subclasses:

SHPStoreProvider

public class DBFStoreProvider
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
static java.lang.String	DESCRIPTION
protected EditableFeatureType	featureType
static int	MAX_FIELD_NAME_LENGTH
static java.lang.String	METADATA_DEFINITION_NAME
static java.lang.String	NAME

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

store

Constructor Summary

Constructors

Modifier	Constructor and Description
	DBFStoreProvider(DBFStoreParameters params, DataStoreProviderServices storeServices)
protected	DBFStoreProvider(DBFStoreParameters params, DataStoreProviderServices storeServices, DynObject metadata)

Method Summary

Modifier and Type	Method and Description
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	canCreate()
boolean	canWriteGeometry(int geometryType, int geometrySubType) unsupported geometry write by default (return false), override this otherwise
protected void	checkNewFieldsNameSize(java.util.Iterator ft_upd)
void	close() do nothing by default, override this otherwise
protected void	closeFile()
boolean	closeResourceRequested(ResourceProvider resource)
FeatureProvider	createFeatureProvider(FeatureType providerFeatureType) Default Factory of FeatureProvider.
FeatureProvider	createFeatureProvider(FeatureType providerFeatureType, FeatureType storeFeatureType)
java.lang.Object	createNewOID() Return a new OID valid for a new feature.
FeatureSetProvider	createSet(FeatureQuery query, FeatureType featureType) Factory of FeatureSetProvider.
FeatureSetProvider	createSet(FeatureQuery query, 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()
protected DBFStoreParameters	getDBFParameters()
java.lang.Object	getDynValue(java.lang.String name)
DataServerExplorer	getExplorer() unsupported by default (return null), override this otherwise
long	getFeatureCount() Returns total feature count of this store.
protected FeatureProvider	getFeatureProviderByIndex(long index)
protected FeatureProvider	getFeatureProviderByIndex(long index, FeatureType providerFeatureType, FeatureType storeFeatureType)
java.lang.String	getFullName() Returns a more descriptive name for the provider that getName.
java.lang.String	getName() Returns the name associated to the provider.
protected java.lang.String	getNewFieldsWithNameTooLong(java.util.Iterator ft_updated) Returns null or a string which is a comma-separated list
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 EditableFeatureType	getTheFeatureType()
protected void	init(DBFStoreParameters params, DataStoreProviderServices storeServices)
protected void	initFeatureProviderByIndex(FeatureProvider featureProvider, long index, FeatureType featureType)
protected void	initFeatureType()
protected void	initResource(DBFStoreParameters params, DataStoreProviderServices storeServices)
protected void	initResource(ResourceProvider resource, DataStoreProviderServices storeServices)
protected FeatureProvider	internalGetFeatureProviderByReference(FeatureReferenceProviderServices reference, FeatureType featureType) Returns a FeatureProvider by reference, using the provided FeatureType.
protected void	loadFeatureProviderByIndex(FeatureProvider featureProvider)
protected void	loadValue(DBFFeatureProvider featureProvider, long rowIndex, FeatureAttributeDescriptor descriptor)
void	open() Open store.
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
void	refresh() do nothing by default, override this otherwise
protected static void	registerMetadataDefinition()
void	resourceChanged(ResourceProvider resource)
protected void	resourceCloseRequest()
protected void	resourcesNotifyChanges()
protected void	resourcesNotifyClose()
protected void	resourcesOpen()
protected void	setStoreFeatureType(FeatureType ftype)
boolean	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, getEnvelope, 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, 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

MAX_FIELD_NAME_LENGTH

public static final int MAX_FIELD_NAME_LENGTH

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

METADATA_DEFINITION_NAME

public static final java.lang.String METADATA_DEFINITION_NAME

See Also:

Constant Field Values

featureType

protected EditableFeatureType featureType

Constructor Detail

DBFStoreProvider

public DBFStoreProvider(DBFStoreParameters params,
                        DataStoreProviderServices storeServices)
                 throws InitializeException

Throws:

InitializeException

DBFStoreProvider

protected DBFStoreProvider(DBFStoreParameters params,
                           DataStoreProviderServices storeServices,
                           DynObject metadata)
                    throws InitializeException

Throws:

InitializeException

Method Detail

registerMetadataDefinition

protected static void registerMetadataDefinition()
                                          throws MetadataException

Throws:

MetadataException

init

protected void init(DBFStoreParameters params,
                    DataStoreProviderServices storeServices)
             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

initResource

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

Throws:

InitializeException

initResource

protected void initResource(ResourceProvider resource,
                            DataStoreProviderServices storeServices)

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:

getDBFParameters

protected DBFStoreParameters getDBFParameters()

getExplorer

public DataServerExplorer getExplorer()
                               throws ReadException

Description copied from class: AbstractFeatureStoreProvider

unsupported by default (return null), override this otherwise

Overrides:

getExplorer in class AbstractFeatureStoreProvider

Returns:

ServerExplorer

Throws:

ReadException

See Also:

DataStoreProvider.getExplorer()

internalGetFeatureProviderByReference

protected 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

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 AbstractFeatureStoreProvider

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)

checkNewFieldsNameSize

protected void checkNewFieldsNameSize(java.util.Iterator ft_upd)
                               throws PerformEditingException

Throws:

PerformEditingException

getNewFieldsWithNameTooLong

protected java.lang.String getNewFieldsWithNameTooLong(java.util.Iterator ft_updated)

Returns null or a string which is a comma-separated list

createFeatureProvider

public FeatureProvider createFeatureProvider(FeatureType providerFeatureType)
                                      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 AbstractFeatureStoreProvider

Returns:

Throws:

DataException

See Also:

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

createFeatureProvider

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

Throws:

DataException

initFeatureType

protected void initFeatureType()
                        throws InitializeException

Throws:

InitializeException

setStoreFeatureType

protected void setStoreFeatureType(FeatureType ftype)

getTheFeatureType

protected EditableFeatureType getTheFeatureType()
                                         throws InitializeException

Throws:

InitializeException

loadValue

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

Throws:

ReadException

getFeatureProviderByIndex

protected FeatureProvider getFeatureProviderByIndex(long index)
                                             throws DataException

Throws:

DataException

getFeatureCount

public long getFeatureCount()
                     throws ReadException,
                            OpenException,
                            ResourceNotifyChangesException

Description copied from interface: FeatureStoreProvider

Returns total feature count of this store.

Specified by:

getFeatureCount in interface FeatureStoreProvider

Returns:

Throws:

ReadException

OpenException

ResourceNotifyChangesException

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

createSet

public FeatureSetProvider createSet(FeatureQuery query,
                                    FeatureType providerFeatureType,
                                    FeatureType storeFeatureType)
                             throws DataException

Specified by:

createSet in interface FeatureStoreProvider

Overrides:

createSet in class AbstractFeatureStoreProvider

Throws:

DataException

canCreate

public boolean canCreate()

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)

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

openFile

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

Throws:

FileNotFoundException

UnsupportedVersionException

java.io.IOException

DataException

close

public void close()
           throws CloseException

Description copied from class: AbstractFeatureStoreProvider

do nothing by default, override this otherwise

Overrides:

close in class AbstractFeatureStoreProvider

Throws:

CloseException

See Also:

DataStoreProvider.close()

closeFile

protected void closeFile()
                  throws CloseException

Throws:

CloseException

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

disposeResource

protected void disposeResource()

closeResourceRequested

public boolean closeResourceRequested(ResourceProvider resource)

Specified by:

closeResourceRequested in interface ResourceConsumer

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

refresh

public void refresh()
             throws OpenException

Description copied from class: AbstractFeatureStoreProvider

do nothing by default, override this otherwise

Overrides:

refresh in class AbstractFeatureStoreProvider

Throws:

OpenException

See Also:

DataStoreProvider.refresh()

getFeatureProviderByIndex

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

Throws:

DataException

initFeatureProviderByIndex

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

Throws:

DataException

loadFeatureProviderByIndex

protected void loadFeatureProviderByIndex(FeatureProvider featureProvider)
                                   throws DataException

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}

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

supportsAppendMode

public boolean supportsAppendMode()

Specified by:

supportsAppendMode in interface FeatureStoreProvider

Overrides:

supportsAppendMode in class AbstractFeatureStoreProvider

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 AbstractFeatureStoreProvider

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 AbstractFeatureStoreProvider

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 AbstractFeatureStoreProvider

Throws:

DataException

See Also:

FeatureStoreProvider.endAppend()

resourceChanged

public void resourceChanged(ResourceProvider resource)

Specified by:

resourceChanged in interface ResourceConsumer

resourcesNotifyChanges

protected void resourcesNotifyChanges()
                               throws ResourceNotifyChangesException

Throws:

ResourceNotifyChangesException

resourcesNotifyClose

protected void resourcesNotifyClose()
                             throws ResourceNotifyCloseException

Throws:

ResourceNotifyCloseException

resourcesOpen

protected void resourcesOpen()
                      throws ResourceNotifyOpenException

Throws:

ResourceNotifyOpenException

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

resourceCloseRequest

protected void resourceCloseRequest()
                             throws ResourceException

Throws:

ResourceException

getResource

public ResourceProvider getResource()

Description copied from interface: DataStoreProvider

Returns the Resource from where the data is being loaded.

Returns:

the data Resource

fixFeatureTypeFromParameters

public void fixFeatureTypeFromParameters()

Specified by:

fixFeatureTypeFromParameters in interface FeatureStoreProvider

Overrides:

fixFeatureTypeFromParameters in class AbstractFeatureStoreProvider