Package org.geotools.data.mongodb

Class MongoFeatureStore

Object

ContentFeatureSource

ContentFeatureStore

MongoFeatureStore

All Implemented Interfaces:

FeatureLocking<SimpleFeatureType,SimpleFeature>, FeatureSource<SimpleFeatureType,SimpleFeature>, FeatureStore<SimpleFeatureType,SimpleFeature>, SimpleFeatureLocking, SimpleFeatureSource, SimpleFeatureStore

public class MongoFeatureStore
extends ContentFeatureStore

Nested Class Summary

Nested classes/interfaces inherited from interface FeatureLocking

FeatureLocking.Response

Field Summary

Fields inherited from class ContentFeatureStore

ORIGINAL_FEATURE_KEY, WRITER_ADD, WRITER_COMMIT, WRITER_UPDATE

Fields inherited from class ContentFeatureSource

entry, hints, lock, query, queryCapabilities, schema, transaction

Constructor Summary

Constructors

Constructor	Description
MongoFeatureStore(ContentEntry entry, Query query, DBCollection collection)

Method Summary

Modifier and Type	Method	Description
protected SimpleFeatureType	buildFeatureType()	Creates the feature type or schema for the feature source.
protected QueryCapabilities	buildQueryCapabilities()	Builds the query capabilities for this feature source.
protected boolean	canFilter(Query query)	Determines if the datastore can natively perform a filtering.
protected boolean	canLimit(Query query)	Determines if the datastore can natively limit the number of features returned in a query.
protected boolean	canOffset(Query query)	Determines if the datastore can natively skip the first offset number of features returned in a query.
protected boolean	canRetype(Query query)	Determines if the datastore can natively perform "retyping" which includes limiting the number of attributes returned and reordering of those attributes
protected boolean	canSort(Query query)	Determines if the datastore can natively perform sorting.
protected ReferencedEnvelope	getBoundsInternal(Query query)	Calculates the bounds of a specified query.
protected int	getCountInternal(Query query)	Calculates the number of features of a specified query.
MongoDataStore	getDataStore()	The datastore that this feature source originated from.
CollectionMapper	getMapper()
protected FeatureReader<SimpleFeatureType,SimpleFeature>	getReaderInternal(Query query)	Subclass method for returning a native reader from the datastore.
protected FeatureWriter<SimpleFeatureType,SimpleFeature>	getWriterInternal(Query query, int flags)	Subclass method for returning a native writer from the datastore.
protected boolean	handleVisitor(Query query, FeatureVisitor visitor)	Subclass method which allows subclasses to natively handle a visitor.
void	setMapper(CollectionMapper mapper)

Methods inherited from class ContentFeatureStore

addFeatures, addFeatures, getWriter, getWriter, getWriter, getWriter, modifyFeatures, modifyFeatures, modifyFeatures, modifyFeatures, modifyFeatures, modifyFeatures, removeFeatures, setFeatures

Methods inherited from class ContentFeatureSource

accepts, addFeatureListener, addHints, canEvent, canFilter, canLimit, canLock, canOffset, canReproject, canRetype, canSort, canTransact, doLockInternal, doUnlockInternal, getAbsoluteSchema, getBounds, getBounds, getCount, getEntry, getFeatures, getFeatures, getFeatures, getInfo, getName, getQueryCapabilities, getReader, getReader, getReader, getSchema, getState, getSupportedHints, getTransaction, getView, getView, isView, joinQuery, lockFeatures, lockFeatures, lockFeatures, processLock, removeFeatureListener, resolvePropertyNames, resolvePropertyNames, setFeatureLock, setTransaction, unLockFeatures, unLockFeatures, unLockFeatures

Methods inherited from class Object

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

Methods inherited from interface FeatureLocking

lockFeatures, lockFeatures, lockFeatures, setFeatureLock, unLockFeatures, unLockFeatures, unLockFeatures

Methods inherited from interface FeatureSource

addFeatureListener, getBounds, getBounds, getCount, getInfo, getName, getQueryCapabilities, getSchema, getSupportedHints, removeFeatureListener

Methods inherited from interface FeatureStore

getTransaction, setTransaction

Methods inherited from interface SimpleFeatureStore

getFeatures, getFeatures, getFeatures

Constructor Detail

MongoFeatureStore

public MongoFeatureStore(ContentEntry entry,
                         Query query,
                         DBCollection collection)

Method Detail

getDataStore

public MongoDataStore getDataStore()

Description copied from class: ContentFeatureSource

The datastore that this feature source originated from.

Subclasses may wish to extend this method in order to type narrow its return type.

Specified by:

getDataStore in interface FeatureSource<SimpleFeatureType,SimpleFeature>

Overrides:

getDataStore in class ContentFeatureSource

Returns:

the data source providing this FeatureSource

getMapper

public CollectionMapper getMapper()

setMapper

public void setMapper(CollectionMapper mapper)

handleVisitor

protected boolean handleVisitor(Query query,
                                FeatureVisitor visitor)
                         throws IOException

Description copied from class: ContentFeatureSource

Subclass method which allows subclasses to natively handle a visitor.

Subclasses would override this method and return true in cases where the specific visitor could be handled without iterating over the entire result set of query. An example would be handling visitors that calculate aggregate values.

Overrides:

handleVisitor in class ContentFeatureSource

Parameters:

query - The query being made.

visitor - The visitor to

Returns:

true if the visitor can be handled natively, otherwise false.

Throws:

IOException

buildFeatureType

protected SimpleFeatureType buildFeatureType()
                                      throws IOException

Description copied from class: ContentFeatureSource

Creates the feature type or schema for the feature source.

Implementations should use SimpleFeatureTypeBuilder to build the feature type. Also, the builder should be injected with the feature factory which has been set on the DataStore (see ContentDataStore.getFeatureFactory(). Example:

   SimpleFeatureTypeBuilder b = new SimpleFeatureTypeBuilder();
   b.setFeatureTypeFactory( getDataStore().getFeatureTypeFactory() );

   //build the feature type
   ...
 

Specified by:

buildFeatureType in class ContentFeatureSource

Throws:

IOException

getCountInternal

protected int getCountInternal(Query query)
                        throws IOException

Description copied from class: ContentFeatureSource

Calculates the number of features of a specified query. Subclasses must implement this method. If the computation is not fast, it's possible to return -1.

Specified by:

getCountInternal in class ContentFeatureSource

Throws:

IOException

getBoundsInternal

protected ReferencedEnvelope getBoundsInternal(Query query)
                                        throws IOException

Description copied from class: ContentFeatureSource

Calculates the bounds of a specified query. Subclasses must implement this method. If the computation is not fast, subclasses can return null.

Specified by:

getBoundsInternal in class ContentFeatureSource

Throws:

IOException

getReaderInternal

protected FeatureReader<SimpleFeatureType,SimpleFeature> getReaderInternal(Query query)
                                                                          throws IOException

Description copied from class: ContentFeatureSource

Subclass method for returning a native reader from the datastore.

It is important to note that if the native reader intends to handle any of the following natively:

• reprojection
• filtering
• max feature limiting
• sorting
• locking
• transactions

Then it *must* set the corresponding flags to true:

• ContentFeatureSource.canReproject() - handles Query.getCoordinateSystemReproject() internally. Example would be PostGIS using Proj to handle reproejction internally
• ContentFeatureSource.canFilter(Query) - handles internally.
• {@link #canLimit(Query)} - handles {@link Query#getMaxFeatures()} and {@link Query#getStartIndex()} internally.
• {@link #canSort(Query)} - handles {@link Query#getSortBy()} natively.
• {@link #canRetype(Query)} - handles {@link Query#getProperties()} natively. Example would be only parsing the properties the user asks for from an XML file
• {@link #canLock()} - handles read-locks natively
• {@link #canTransact()} - handles transactions natively

Specified by:

getReaderInternal in class ContentFeatureSource

Throws:

IOException

canOffset

protected boolean canOffset(Query query)

Description copied from class: ContentFeatureSource

Determines if the datastore can natively skip the first offset number of features returned in a query.

If the subclass can handle a map feature cap natively then it should override this method to return true. In this case it must do the cap or throw an exception.

Not overriding this method or returning false will case the feature reader created by the subclass to be accessed offset times before being returned to the caller.

Overrides:

canOffset in class ContentFeatureSource

canLimit

protected boolean canLimit(Query query)

Description copied from class: ContentFeatureSource

Determines if the datastore can natively limit the number of features returned in a query.

If the subclass can handle a map feature cap natively then it should override this method to return true. In this case it must do the cap or throw an exception.

Not overriding this method or returning false will case the feature reader created by the subclass to be wrapped in a max feature capping decorator when the query specifies a max feature cap.

Overrides:

canLimit in class ContentFeatureSource

See Also:

MaxFeatureReader

canRetype

protected boolean canRetype(Query query)

Description copied from class: ContentFeatureSource

Determines if the datastore can natively perform "retyping" which includes limiting the number of attributes returned and reordering of those attributes

If the subclass can handle retyping natively it should override this method to return true. In this case it must do the retyping or throw an exception.

Not overriding this method or returning false will cause the feature reader created by the subclass to be wrapped in a retyping feature reader when the query specifies a retype.

Overrides:

canRetype in class ContentFeatureSource

See Also:

ReTypeFeatureReader

canSort

protected boolean canSort(Query query)

Description copied from class: ContentFeatureSource

Determines if the datastore can natively perform sorting.

If the subclass can handle retyping natively it should override this method to return true. In this case it must do the retyping or throw an exception.

Not overriding this method or returning false will cause an exception to be thrown when the query specifies sorting.

Overrides:

canSort in class ContentFeatureSource

See Also:

SortedFeatureReader

canFilter

protected boolean canFilter(Query query)

Description copied from class: ContentFeatureSource

Determines if the datastore can natively perform a filtering.

If the subclass can handle filtering natively it should override this method to return true. In this case it must do the filtering or throw an exception. This includes the case of partial native filtering where the datastore can only handle part of the filter natively. In these cases it is up to the subclass to apply a decorator to the reader it returns which will handle any part of the filter can was not applied natively. See FilteringFeatureReader.

Not overriding this method or returning false will cause the feature reader created by the subclass to be wrapped in a filtering feature reader when the query specifies a filter. See FilteringFeatureReader.

Overrides:

canFilter in class ContentFeatureSource

getWriterInternal

protected FeatureWriter<SimpleFeatureType,SimpleFeature> getWriterInternal(Query query,
                                                                                 int flags)
                                                                          throws IOException

Description copied from class: ContentFeatureStore

Subclass method for returning a native writer from the datastore.

It is important to note that if the native writer intends to handle any of the following natively:

• reprojection
• filtering
• events
• max feature limiting
• sorting
• locking

Then it *must* set the corresponding flags to true:

• ContentFeatureSource.canReproject()
• ContentFeatureSource.canFilter(Query)
• ContentFeatureSource.canEvent()
• ContentFeatureSource.canLimit(Query)
• ContentFeatureSource.canSort(Query)
• ContentFeatureSource.canLock()

Specified by:

getWriterInternal in class ContentFeatureStore

Parameters:

query - Query

flags - See ContentFeatureStore.WRITER_ADD and ContentFeatureStore.WRITER_UPDATE

Throws:

IOException

buildQueryCapabilities

protected QueryCapabilities buildQueryCapabilities()

Description copied from class: ContentFeatureSource

Builds the query capabilities for this feature source. The default implementation returns a newly built QueryCapabilities, subclasses are advised to build their own.

Overrides:

buildQueryCapabilities in class ContentFeatureSource