org.gvsig.fmap.dal.store.simplereader

Class SimpleReaderStoreProvider

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.feature.spi.memory.AbstractMemoryStoreProvider

org.gvsig.fmap.dal.store.simplereader.SimpleReaderStoreProvider

All Implemented Interfaces:

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

Direct Known Subclasses:

CSVStoreProvider, GMLStoreProvider, JsonStoreProvider

public abstract class SimpleReaderStoreProvider
extends AbstractMemoryStoreProvider
implements ResourceConsumer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleReaderStoreProvider.RowToFeatureTranslator

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

AbstractMemoryStoreProvider.MemoryFeatureProvider

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 long	counterNewsOIDs
protected java.util.Map<java.lang.String,Envelope>	envelopes
protected FeatureType	featureType
protected static Logger	LOGGER
protected boolean	need_calculate_envelope
protected ResourceProvider	resource
protected SimpleReaderStoreProvider.RowToFeatureTranslator	rowToFeatureTranslator
protected java.util.Map<java.lang.String,SpatialIndex>	spatialIndexes
protected SimpleTaskStatus	taskStatus
protected GetItemWithSize64<java.util.List<java.lang.String>>	virtualrows

Fields inherited from class org.gvsig.fmap.dal.feature.spi.memory.AbstractMemoryStoreProvider

data

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

store

Constructor Summary

Constructors

Constructor and Description
SimpleReaderStoreProvider(SimpleReaderStoreParameters parameters, 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
protected Envelope	bboxFileLoad(java.io.File bboxfile)
protected Envelope	bboxFileLoad(java.lang.String suffix)
protected void	bboxFileSave(Envelope envelope)
protected void	bboxFileSave(java.io.File bboxfile, Envelope envelope)
protected void	bboxFileSave(java.util.Map<java.lang.String,Envelope> envelopes)
protected void	bboxFileSave(java.lang.String suffix, Envelope envelope)
void	beginAppend() unsupported by default, override this otherwise
void	close() do nothing by default, override this otherwise
boolean	closeResourceRequested(ResourceProvider resource)
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 featureType)
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.io.File	getAuxFile(java.lang.String extension)
java.io.File	getAuxFile(java.lang.String suffix, java.lang.String extension)
long	getDataSize() Return the current size of the memory store.
java.lang.Object	getDynValue(java.lang.String name)
Envelope	getEnvelope() unsupported geometry by default (return null), override this otherwise
Envelope	getEnvelope(java.lang.String geomName) Override on providers that allow more than one geometry
DataServerExplorer	getExplorer() unsupported by default (return null), override this otherwise
long	getFeatureCount() Returns total feature count of this store.
protected abstract SimpleReaderFeatureTypeLoader	getFeatureTypeLoader()
protected java.lang.String	getFullFileName()
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.
int	getOIDType() Return OID data type (from DataTypes) of this store.
abstract java.lang.String	getProviderName() Return the name of the provider.
ResourceProvider	getResource() Returns the Resource from where the data is being loaded.
java.util.List<java.lang.String>	getRowByIndex(long index)
SimpleReaderStoreProvider.RowToFeatureTranslator	getRowToFeatureTranslator()
protected abstract SimpleReader	getSimpleReader(SimpleReaderStoreParameters parameters, java.io.Reader in)
java.lang.Object	getSourceId() Returns the unique identifier of the Store FIXME add examples
SpatialIndex	getSpatialIndex()
SpatialIndex	getSpatialIndex(java.lang.String geomName)
FilteredLogger	getTimedLogger()
protected void	initializeFeatureTypes()
protected FeatureProvider	internalGetFeatureProviderByReference(FeatureReferenceProviderServices reference) Returns a FeatureProvider by reference, using the default FeatureType.
protected void	loadFeatures()
void	loadFromState(PersistentState state)
protected boolean	mustFixFeatureType()
void	open() Open store.
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
void	resourceChanged(ResourceProvider resource)
void	saveToState(PersistentState state)
boolean	supportsAppendMode()

Methods inherited from class org.gvsig.fmap.dal.feature.spi.memory.AbstractMemoryStoreProvider

addFeatureProvider, createFeatureProvider, getMemoryProvider, internalGetFeatureProviderByReference

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

abortAppend, allowAutomaticValues, allowGeometry, beginAppend, canWriteGeometry, clear, createExpression, createFeatureLocks, createFeatureSelection, createResource, delegate, getChildren, getDynClass, 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, 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

LOGGER

protected static final Logger LOGGER

resource

protected final ResourceProvider resource

counterNewsOIDs

protected long counterNewsOIDs

envelopes

protected java.util.Map<java.lang.String,Envelope> envelopes

need_calculate_envelope

protected boolean need_calculate_envelope

taskStatus

protected final SimpleTaskStatus taskStatus

featureType

protected FeatureType featureType

virtualrows

protected GetItemWithSize64<java.util.List<java.lang.String>> virtualrows

rowToFeatureTranslator

protected SimpleReaderStoreProvider.RowToFeatureTranslator rowToFeatureTranslator

spatialIndexes

protected java.util.Map<java.lang.String,SpatialIndex> spatialIndexes

Constructor Detail

SimpleReaderStoreProvider

public SimpleReaderStoreProvider(SimpleReaderStoreParameters parameters,
                                 DataStoreProviderServices storeServices,
                                 DynObject metadata)
                          throws InitializeException

Throws:

InitializeException

Method Detail

getProviderName

public abstract 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

getFullFileName

protected java.lang.String getFullFileName()

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

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

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 AbstractMemoryStoreProvider

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)

closeResourceRequested

public boolean closeResourceRequested(ResourceProvider resource)

Specified by:

closeResourceRequested in interface ResourceConsumer

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}

supportsAppendMode

public boolean supportsAppendMode()

Specified by:

supportsAppendMode in interface FeatureStoreProvider

Overrides:

supportsAppendMode in class AbstractFeatureStoreProvider

append

public void append(FeatureProvider featureProvider)

Description copied from class: AbstractFeatureStoreProvider

unsupported by default, override this otherwise

Specified by:

append in interface FeatureStoreProvider

Overrides:

append in class AbstractFeatureStoreProvider

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

Description copied from class: AbstractFeatureStoreProvider

unsupported by default, override this otherwise

Specified by:

endAppend in interface FeatureStoreProvider

Overrides:

endAppend in class AbstractFeatureStoreProvider

See Also:

FeatureStoreProvider.endAppend()

saveToState

public void saveToState(PersistentState state)
                 throws PersistenceException

Throws:

PersistenceException

loadFromState

public void loadFromState(PersistentState state)
                   throws PersistenceException

Throws:

PersistenceException

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

initializeFeatureTypes

protected void initializeFeatureTypes()
                               throws InitializeException

Throws:

InitializeException

getEnvelope

public Envelope getEnvelope(java.lang.String geomName)
                     throws DataException

Description copied from class: AbstractFeatureStoreProvider

Override on providers that allow more than one geometry

Specified by:

getEnvelope in interface FeatureStoreProvider

Overrides:

getEnvelope in class AbstractFeatureStoreProvider

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

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

resourceChanged

public void resourceChanged(ResourceProvider resource)

Specified by:

resourceChanged in interface ResourceConsumer

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

getResource

public ResourceProvider getResource()

Description copied from interface: DataStoreProvider

Returns the Resource from where the data is being loaded.

Returns:

the data Resource

getFeatureTypeLoader

protected abstract SimpleReaderFeatureTypeLoader getFeatureTypeLoader()

loadFeatures

protected void loadFeatures()

fixFeatureTypeFromParameters

public void fixFeatureTypeFromParameters()

Specified by:

fixFeatureTypeFromParameters in interface FeatureStoreProvider

Overrides:

fixFeatureTypeFromParameters in class AbstractFeatureStoreProvider

mustFixFeatureType

protected boolean mustFixFeatureType()

createSet

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

Specified by:

createSet in interface FeatureStoreProvider

Overrides:

createSet in class AbstractFeatureStoreProvider

Throws:

DataException

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

Overrides:

createSet in class AbstractMemoryStoreProvider

Parameters:

query - (never will be null)

featureType - (never will be null)

Returns:

Throws:

DataException

getRowByIndex

public java.util.List<java.lang.String> getRowByIndex(long index)

getRowToFeatureTranslator

public SimpleReaderStoreProvider.RowToFeatureTranslator getRowToFeatureTranslator()

getFeatureCount

public long getFeatureCount()
                     throws DataException

Description copied from interface: FeatureStoreProvider

Returns total feature count of this store.

Specified by:

getFeatureCount in interface FeatureStoreProvider

Overrides:

getFeatureCount in class AbstractMemoryStoreProvider

Returns:

Throws:

DataException

getDataSize

public long getDataSize()
                 throws DataException

Description copied from class: AbstractMemoryStoreProvider

Return the current size of the memory store.

Overrides:

getDataSize in class AbstractMemoryStoreProvider

Returns:

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 AbstractMemoryStoreProvider

Parameters:

reference - the reference to the FeatureProvider

Returns:

the FeatureProvider being referenced

Throws:

DataException - if there is an error loading the FeatureProvider

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 AbstractMemoryStoreProvider

Throws:

BaseException

See Also:

AbstractDisposable.dispose()

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

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

getAuxFile

public java.io.File getAuxFile(java.lang.String extension)

getAuxFile

public java.io.File getAuxFile(java.lang.String suffix,
                               java.lang.String extension)

getSpatialIndex

public SpatialIndex getSpatialIndex(java.lang.String geomName)

getSpatialIndex

public SpatialIndex getSpatialIndex()

bboxFileSave

protected void bboxFileSave(java.util.Map<java.lang.String,Envelope> envelopes)

bboxFileSave

protected void bboxFileSave(Envelope envelope)

bboxFileSave

protected void bboxFileSave(java.lang.String suffix,
                            Envelope envelope)

bboxFileSave

protected void bboxFileSave(java.io.File bboxfile,
                            Envelope envelope)

bboxFileLoad

protected Envelope bboxFileLoad(java.lang.String suffix)

bboxFileLoad

protected Envelope bboxFileLoad(java.io.File bboxfile)

getSimpleReader

protected abstract SimpleReader getSimpleReader(SimpleReaderStoreParameters parameters,
                                                java.io.Reader in)
                                         throws java.io.IOException

Throws:

java.io.IOException

getTimedLogger

public FilteredLogger getTimedLogger()