org.deegree.feature.persistence.shape
Class ShapeFeatureStore

java.lang.Object
  org.deegree.feature.persistence.shape.ShapeFeatureStore

All Implemented Interfaces:

Resource, FeatureStore

public class ShapeFeatureStore
extends Object
implements FeatureStore

FeatureStore implementation that uses shape files as backend.

Version:

$Revision: 31898 $, $Date: 2011-09-15 17:50:53 +0200 (Thu, 15 Sep 2011) $

Author:

Andreas Schmitz, Markus Schneider, last edited by: $Author: mschneider $

See Also:

FeatureStore

Constructor Summary

ShapeFeatureStore(String shpName, ICRS crs, Charset encoding, String ftNamespace, String localFtName, String ftPrefix, boolean generateAlphanumericIndexes, FeatureStoreCache cache, List<org.deegree.feature.persistence.shape.ShapeFeatureStoreProvider.Mapping> mappings)
Creates a new ShapeFeatureStore instance from the given parameters.

Method Summary

FeatureStoreTransaction	acquireTransaction() Acquires transactional access to the feature store.
Envelope	calcEnvelope(QName ftName) Recalculates the envelope for all stored features of the given type.
void	destroy() Usually called by the ResourceManager upon workspace shutdown.
Envelope	getEnvelope(QName ftName) Returns the envelope for all stored features of the given type.
LockManager	getLockManager() Returns the associated LockManager.
GMLObject	getObjectById(String id) Retrieves the stored object with a certain id.
AppSchema	getSchema() Returns the application schema that this FeatureStore serves.
ICRS	getStorageCRS() Returns the CRS used by the shape file.
void	init(DeegreeWorkspace workspace) Usually called by the ResourceManager upon workspace startup.
boolean	isAvailable() Returns whether the store is currently able to perform operations.
FeatureInputStream	query(Query query) Performs the given query and returns the matching features as a FeatureInputStream.
FeatureInputStream	query(Query[] queries) Performs the given queries and returns the matching features as a FeatureInputStream.
int	queryHits(Query query) Returns the number of features that are matched by the given query.
int[]	queryHits(Query[] queries) Returns the number of features that are matched by the given queries.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShapeFeatureStore

public ShapeFeatureStore(String shpName,
                         ICRS crs,
                         Charset encoding,
                         String ftNamespace,
                         String localFtName,
                         String ftPrefix,
                         boolean generateAlphanumericIndexes,
                         FeatureStoreCache cache,
                         List<org.deegree.feature.persistence.shape.ShapeFeatureStoreProvider.Mapping> mappings)

Creates a new ShapeFeatureStore instance from the given parameters.

Parameters:

shpName - name of the shape file to be loaded, may omit the ".shp" extension, must not be nullcrs - crs used by the shape file, must not be null

encoding - encoding used in the dbf file, can be null (encoding guess mode)

ftNamespace - namespace to be used for the feature type, must not be null

localFtName - if null, the shape file base name will be used

ftPrefix -

generateAlphanumericIndexes - whether to copy the dbf into a h2 database for indexing

cache - used for caching retrieved feature instances, can be null (will create a default cache)

mappings - may be null, in which case the original DBF names and 'geometry' will be used

Method Detail

init

public void init(DeegreeWorkspace workspace)
          throws ResourceInitException

Description copied from interface: Resource

Usually called by the ResourceManager upon workspace startup.

Specified by:

init in interface Resource

Parameters:

workspace - the workspace the resource belongs to, may be null

Throws:

ResourceInitException

query

public FeatureInputStream query(Query query)
                         throws FilterEvaluationException,
                                FeatureStoreException

Description copied from interface: FeatureStore

Performs the given query and returns the matching features as a FeatureInputStream.

Specified by:

query in interface FeatureStore

Parameters:

query - query to be performed, must not be null

Returns:

matching features, never null

Throws:

FilterEvaluationException - if the filter contained in the query could not be evaluated

FeatureStoreException - if the query could not be performed

query

public FeatureInputStream query(Query[] queries)
                         throws FeatureStoreException,
                                FilterEvaluationException

Description copied from interface: FeatureStore

Performs the given queries and returns the matching features as a FeatureInputStream.

Specified by:

query in interface FeatureStore

Parameters:

queries - queries to be performed, must not be null and contain at least one entry

Returns:

matching features, never null

Throws:

FeatureStoreException - if the query could not be performed

FilterEvaluationException - if the filter contained in the query could not be evaluated

queryHits

public int queryHits(Query query)
              throws FeatureStoreException,
                     FilterEvaluationException

Description copied from interface: FeatureStore

Returns the number of features that are matched by the given query.

Specified by:

queryHits in interface FeatureStore

Parameters:

query - query to be performed, must not be null

Returns:

number of matching featuress

Throws:

FeatureStoreException - if the query could not be performed

FilterEvaluationException - if the filter contained in the query could not be evaluated

queryHits

public int[] queryHits(Query[] queries)
                throws FeatureStoreException,
                       FilterEvaluationException

Description copied from interface: FeatureStore

Returns the number of features that are matched by the given queries.

Specified by:

queryHits in interface FeatureStore

Parameters:

queries - queries to be performed, must not be null and contain at least one entry

Returns:

number of matching features, one entry per query

Throws:

FeatureStoreException - if the query could not be performed

FilterEvaluationException - if the filter contained in the query could not be evaluated

getEnvelope

public Envelope getEnvelope(QName ftName)
                     throws FeatureStoreException

Description copied from interface: FeatureStore

Returns the envelope for all stored features of the given type.

NOTE: This method may return incorrect (cached) results. Use FeatureStore.calcEnvelope(QName) to force the recalculation of the Envelope.

Specified by:

getEnvelope in interface FeatureStore

Parameters:

ftName - name of the feature type, must not be null and must be served by this store

Returns:

the envelope (using the storage CRS), or null if the feature type does not have an envelope (no geometry properties or no instances)

Throws:

FeatureStoreException

calcEnvelope

public Envelope calcEnvelope(QName ftName)

Description copied from interface: FeatureStore

Recalculates the envelope for all stored features of the given type.

NOTE: This method may potentially be expensive. Depending on the implementation, it may involve fetching all features of the specified type.

Specified by:

calcEnvelope in interface FeatureStore

Parameters:

ftName - name of the feature type, must not be null and must be served by this store

Returns:

the envelope (using the storage CRS), or null if the feature type does not have an envelope (no geometry properties or no instances)

destroy

public void destroy()

Description copied from interface: Resource

Usually called by the ResourceManager upon workspace shutdown.

Specified by:

destroy in interface Resource

isAvailable

public boolean isAvailable()

Description copied from interface: FeatureStore

Returns whether the store is currently able to perform operations.

Specified by:

isAvailable in interface FeatureStore

Returns:

whether the shape file is currently available

acquireTransaction

public FeatureStoreTransaction acquireTransaction()
                                           throws FeatureStoreException

Description copied from interface: FeatureStore

Acquires transactional access to the feature store.

Specified by:

acquireTransaction in interface FeatureStore

Returns:

transaction object that allows to perform transactions operations on the datastore, never null

Throws:

FeatureStoreException - if the transactional access could not be acquired or is not implemented for this FeatureStore

getLockManager

public LockManager getLockManager()
                           throws FeatureStoreException

Description copied from interface: FeatureStore

Returns the associated LockManager.

Specified by:

getLockManager in interface FeatureStore

Returns:

the associated LockManager instance, or null if the FeatureStore does not implement locking

Throws:

FeatureStoreException - if the lock manager could not be acquired

getObjectById

public GMLObject getObjectById(String id)
                        throws FeatureStoreException

Description copied from interface: FeatureStore

Retrieves the stored object with a certain id.

Specified by:

getObjectById in interface FeatureStore

Parameters:

id - identifier of the object to be retrieved

Returns:

the stored object (currently either a Feature or a Geometry) or null if no object with the given id is known

Throws:

FeatureStoreException - if the query could not be performed

getSchema

public AppSchema getSchema()

Description copied from interface: FeatureStore

Returns the application schema that this FeatureStore serves.

Specified by:

getSchema in interface FeatureStore

Returns:

the served application schema, never null

getStorageCRS

public ICRS getStorageCRS()

Returns the CRS used by the shape file.

Returns:

the CRS used by the shape file, never null