|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.geotools.data.store.ContentFeatureSource
org.geotools.data.store.ContentFeatureStore
org.geotools.jdbc.JDBCFeatureStore
public final class JDBCFeatureStore
FeatureStore implementation for jdbc based relational database tables.
All read only methods are delegated to JDBCFeatureSource
.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.geotools.data.FeatureLocking |
---|
FeatureLocking.Response |
Field Summary |
---|
Fields inherited from class org.geotools.data.store.ContentFeatureStore |
---|
lock, WRITER_ADD, WRITER_UPDATE |
Fields inherited from class org.geotools.data.store.ContentFeatureSource |
---|
entry, hints, query, queryCapabilities, schema, transaction |
Constructor Summary | |
---|---|
JDBCFeatureStore(ContentEntry entry,
Query query)
Creates the new feature store. |
Method Summary | |
---|---|
protected org.opengis.feature.simple.SimpleFeatureType |
buildFeatureType()
Creates the feature type or schema for the feature source. |
protected boolean |
canFilter()
Determines if the datastore can natively perform a filtering. |
protected boolean |
canLimit()
Determines if the datastore can natively limit the number of features returned in a query. |
protected boolean |
canOffset()
Determines if the datastore can natively skip the first offset number of features
returned in a query. |
protected boolean |
canRetype()
Determines if the datasatore can natively perform "retyping" which includes limiting the number of attributes returned and reordering of those attributes |
protected boolean |
canSort()
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. |
JDBCDataStore |
getDataStore()
The datastore that this feature source originated from. |
ContentEntry |
getEntry()
The entry for the feature source. |
ResourceInfo |
getInfo()
A default ResourceInfo with a generic description. |
org.opengis.feature.type.Name |
getName()
Returns the same name than the feature type (ie, getSchema().getName() to honor the simple feature land common
practice of calling the same both the Features produces and their types |
PrimaryKey |
getPrimaryKey()
|
QueryCapabilities |
getQueryCapabilities()
FeatureCollection |
protected FeatureReader<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature> |
getReaderInternal(Query query)
Subclass method for returning a native reader from the datastore. |
JDBCState |
getState()
The current state for the feature source. |
Transaction |
getTransaction()
The current transaction the feature source is working against. |
protected FeatureWriter<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature> |
getWriterInternal(Query query,
int flags)
Subclass method for returning a native writer from the datastore. |
protected boolean |
handleVisitor(Query query,
org.opengis.feature.FeatureVisitor visitor)
Subclass method which allows subclasses to natively handle a visitor. |
boolean |
isExposePrimaryKeyColumns()
The flag which will expose columns which compose a tables identifying or primary key, through feature type attributes. |
void |
modifyFeatures(org.opengis.feature.type.AttributeDescriptor[] types,
java.lang.Object[] values,
org.opengis.filter.Filter filter)
Modifies/updates the features of the store which match the specified filter. |
void |
removeFeatures(org.opengis.filter.Filter filter)
Removes the features from the store which match the specified filter. |
void |
setExposePrimaryKeyColumns(boolean exposePrimaryKeyColumns)
Sets the flag which will expose columns which compose a tables identifying or primary key, through feature type attributes. |
void |
setTransaction(Transaction transaction)
Sets the current transaction the feature source is working against. |
Methods inherited from class org.geotools.data.store.ContentFeatureStore |
---|
addFeatures, addFeatures, getWriter, getWriter, getWriter, getWriter, lockFeatures, lockFeatures, lockFeatures, modifyFeatures, setFeatureLock, setFeatures, unLockFeatures, unLockFeatures, unLockFeatures |
Methods inherited from class org.geotools.data.store.ContentFeatureSource |
---|
accepts, addFeatureListener, addHints, buildQueryCapabilities, canReproject, getAbsoluteSchema, getBounds, getBounds, getCount, getFeatures, getFeatures, getFeatures, getReader, getReader, getReader, getSchema, getSupportedHints, getView, getView, isView, joinQuery, removeFeatureListener, resolvePropertyNames, resolvePropertyNames |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.geotools.data.FeatureSource |
---|
addFeatureListener, getBounds, getBounds, getCount, getFeatures, getFeatures, getFeatures, getSchema, getSupportedHints, removeFeatureListener |
Constructor Detail |
---|
public JDBCFeatureStore(ContentEntry entry, Query query) throws java.io.IOException
entry
- The datastore entry.query
- The defining query.
java.io.IOException
Method Detail |
---|
public JDBCDataStore getDataStore()
ContentFeatureSource
Subclasses may wish to extend this method in order to type narrow its return type.
getDataStore
in interface FeatureSource<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>
getDataStore
in class ContentFeatureSource
public ContentEntry getEntry()
ContentFeatureSource
getEntry
in class ContentFeatureSource
public ResourceInfo getInfo()
ContentFeatureSource
Subclasses should override to provide an explicit ResourceInfo object for their content.
getInfo
in interface FeatureSource<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>
getInfo
in class ContentFeatureSource
public org.opengis.feature.type.Name getName()
ContentFeatureSource
getSchema().getName()
to honor the simple feature land common
practice of calling the same both the Features produces and their types
getName
in interface FeatureSource<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>
getName
in class ContentFeatureSource
FeatureSource.getName()
public QueryCapabilities getQueryCapabilities()
ContentFeatureSource
Available via getView( filter ):
In particular this method of data access is intended for rendering and other high speed operations; care should be taken to optimize the use of FeatureVisitor.
getQueryCapabilities
in interface FeatureSource<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>
getQueryCapabilities
in class ContentFeatureSource
public JDBCState getState()
ContentFeatureSource
This value is derived from current transaction of the feature source.
getState
in class ContentFeatureSource
#setTransaction(Transaction)}.
public Transaction getTransaction()
ContentFeatureSource
This transaction is used to derive the state for the feature source. A
null
value for a transaction represents the auto commit
transaction: Transaction.AUTO_COMMIT
.
getTransaction
in interface FeatureStore<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>
getTransaction
in class ContentFeatureSource
Transaction.AUTO_COMMIT
#getState()}.
public void setTransaction(Transaction transaction)
ContentFeatureSource
transaction may be null
. This signifies that the
auto-commit transaction is used: Transaction.AUTO_COMMIT
.
setTransaction
in interface FeatureStore<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>
setTransaction
in class ContentFeatureSource
transaction
- The new transaction, or null
.public PrimaryKey getPrimaryKey()
public void setExposePrimaryKeyColumns(boolean exposePrimaryKeyColumns)
Note: setting this flag which affect all feature sources created from or working against the current transaction.
public boolean isExposePrimaryKeyColumns()
protected org.opengis.feature.simple.SimpleFeatureType buildFeatureType() throws java.io.IOException
ContentFeatureSource
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 ...
buildFeatureType
in class ContentFeatureSource
java.io.IOException
protected int getCountInternal(Query query) throws java.io.IOException
ContentFeatureSource
getCountInternal
in class ContentFeatureSource
java.io.IOException
protected ReferencedEnvelope getBoundsInternal(Query query) throws java.io.IOException
ContentFeatureSource
getBoundsInternal
in class ContentFeatureSource
java.io.IOException
protected boolean canFilter()
ContentFeatureSource
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
.
canFilter
in class ContentFeatureSource
protected boolean canSort()
ContentFeatureSource
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.
canSort
in class ContentFeatureSource
protected boolean canRetype()
ContentFeatureSource
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.
canRetype
in class ContentFeatureSource
protected boolean canLimit()
ContentFeatureSource
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.
canLimit
in class ContentFeatureSource
MaxFeatureReader
protected boolean canOffset()
ContentFeatureSource
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 be accesset offset times before
being returned to the caller.
canOffset
in class ContentFeatureSource
protected FeatureReader<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature> getReaderInternal(Query query) throws java.io.IOException
ContentFeatureSource
It is important to note that if the native reader intends to handle any of the following natively:
true
:
ContentFeatureSource.canReproject()
ContentFeatureSource.canFilter()
ContentFeatureSource.canLimit()
ContentFeatureSource.canSort()
getReaderInternal
in class ContentFeatureSource
java.io.IOException
protected boolean handleVisitor(Query query, org.opengis.feature.FeatureVisitor visitor) throws java.io.IOException
ContentFeatureSource
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.
handleVisitor
in class ContentFeatureSource
query
- The query being made.visitor
- The visitor to
java.io.IOException
protected FeatureWriter<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature> getWriterInternal(Query query, int flags) throws java.io.IOException
ContentFeatureStore
It is important to note that if the native writer intends to handle any of the following natively:
true
:
ContentFeatureSource.canReproject()
ContentFeatureSource.canFilter()
ContentFeatureSource.canLimit()
ContentFeatureSource.canSort()
getWriterInternal
in class ContentFeatureStore
java.io.IOException
public void modifyFeatures(org.opengis.feature.type.AttributeDescriptor[] types, java.lang.Object[] values, org.opengis.filter.Filter filter) throws java.io.IOException
ContentFeatureStore
This method operates by obtaining an updating feature writer based on the specified filter and writing the updated values to it.
The filter must not be null
, in this case this method
will throw an IllegalArgumentException
.
modifyFeatures
in interface FeatureStore<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>
modifyFeatures
in class ContentFeatureStore
types
- The attributes to modify.values
- The values to put in the attribute types.filter
- An OGC filter to note which attributes to modify.
java.io.IOException
- if the attribute and object arrays are not eqaul
length, if the object types do not match the attribute types,
or if there are backend errors.public void removeFeatures(org.opengis.filter.Filter filter) throws java.io.IOException
ContentFeatureStore
This method operates by obtaining an updating feature writer based on the specified filter and removing every feature from it.
The filter must not be null
, in this case this method
will throw an IllegalArgumentException
.
removeFeatures
in interface FeatureStore<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>
removeFeatures
in class ContentFeatureStore
filter
- An OpenGIS filter; specifies which features to remove.
java.io.IOException
- If anything goes wrong.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |