org.geotools.data.jdbc
Class JDBCFeatureStore

java.lang.Object
  org.geotools.data.jdbc.JDBCFeatureSource
      org.geotools.data.jdbc.JDBCFeatureStore

All Implemented Interfaces:

FeatureSource, FeatureStore

Direct Known Subclasses:

JDBCFeatureLocking, PostgisFeatureStore

public class JDBCFeatureStore

extends JDBCFeatureSource

implements FeatureStore

This is a starting point for providing your own FeatureStore implementation.

Author:

Jody Garnett, Refractions Research

Task:

REVISIT: Make modify/add/remove atomic if the transaction is AUTO_COMMIT. This is done by the start of each of those method checking to see if the transaction is auto-commit, if it is then they make a new transaction and pass that to the writer. The writer does its thing, and then at the end of the method you just commit the transaction. This way if the writer messes up its changes are rolled back. The old jdbc datasources supported this, and it'd be nice to do here as well., UPDATE: made modify atomic as an example, I actually have the beginings of a smart idea in mind. Similar to SwingUtilities.runLater...

Field Summary

protected Transaction

transaction Current Transaction this FeatureSource is opperating against

Constructor Summary

JDBCFeatureStore(JDBC1DataStore jdbcDataStore, FeatureType featureType)

Method Summary

java.util.Set	addFeatures(FeatureReader reader) Add Features from reader to this FeatureStore.
protected void	assertFids(java.util.Set fids)
protected void	assertFilter(Filter filter)
protected java.util.Set	fids(Filter filter)
protected InProcessLockingManager	getInProcessLockingManager() Used by subclasses to access locking manager.
Transaction	getTransaction() Used to access the Transaction this DataSource is currently opperating against.
protected void	modifyFeatures(AttributeType[] type, java.lang.Object[] value, FeatureWriter writer)
void	modifyFeatures(AttributeType[] type, java.lang.Object[] value, Filter filter) Modifies features matching filter.
void	modifyFeatures(AttributeType type, java.lang.Object value, Filter filter) Modifies features matching filter.
void	removeFeatures(Filter filter) Removes features indicated by provided filter.
void	setFeatures(FeatureReader reader) Replace with contents of reader.
void	setTransaction(Transaction transaction) Provides a transaction for commit/rollback control of this FeatureStore.

Methods inherited from class org.geotools.data.jdbc.JDBCFeatureSource

addFeatureListener, close, close, close, count, getBounds, getBounds, getConnection, getCount, getDataStore, getFeatures, getFeatures, getFeatures, getJDBCDataStore, getSchema, removeFeatureListener

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, getDataStore, getFeatures, getFeatures, getFeatures, getSchema, removeFeatureListener

Field Detail

transaction

protected Transaction transaction

Current Transaction this FeatureSource is opperating against

Constructor Detail

JDBCFeatureStore

public JDBCFeatureStore(JDBC1DataStore jdbcDataStore,
                        FeatureType featureType)

Method Detail

getTransaction

public Transaction getTransaction()

Description copied from interface: FeatureStore

Used to access the Transaction this DataSource is currently opperating against.

Example Use: adding features to a road DataSource

 Transaction t = roads.getTransaction();
 try{
     roads.addFeatures( features );
     roads.getTransaction().commit();
 }
 catch( IOException erp ){
     //something went wrong;
     roads.getTransaction().rollback();
 }
 

Specified by:

getTransaction in interface FeatureStore

Overrides:

getTransaction in class JDBCFeatureSource

Returns:

DOCUMENT ME!

getInProcessLockingManager

protected InProcessLockingManager getInProcessLockingManager()

Used by subclasses to access locking manager.

All our implementations here are rely on FeatureWriter to check the locks.

When making your own SQL opperations, have a look at assertFids( Set fids ), and assertFids( Filter ). You may use these to check against the lockingManager if one is used.

If the lockingManager is not used, ie is null, it assumed that you are making use of native database locks. Or doing your own thing.

That is the assertFids functions only when lockingManager is non null.

Returns:

LockingManager

fids

protected java.util.Set fids(Filter filter)
                      throws java.util.NoSuchElementException,
                             java.io.IOException,
                             IllegalAttributeException

Throws:

java.util.NoSuchElementException

java.io.IOException

IllegalAttributeException

assertFilter

protected void assertFilter(Filter filter)
                     throws java.io.IOException

Throws:

java.io.IOException

assertFids

protected void assertFids(java.util.Set fids)
                   throws FeatureLockException

Throws:

FeatureLockException

modifyFeatures

public void modifyFeatures(AttributeType type,
                           java.lang.Object value,
                           Filter filter)
                    throws java.io.IOException

Modifies features matching filter.

Equivelent to:

 modifyFeatures( new AttributeType[]{ type, }, new Object[]{ value, }, filter );
 
 

Subclasses may override this method to perform the appropriate optimization for this result.

Specified by:

modifyFeatures in interface FeatureStore

Parameters:

type - Attribute to modify

value - Modification being made to type

filter - Identifies features to modify

Throws:

java.io.IOException

See Also:

FeatureStore.modifyFeatures(org.geotools.feature.AttributeType, java.lang.Object, org.geotools.filter.Filter)

modifyFeatures

public void modifyFeatures(AttributeType[] type,
                           java.lang.Object[] value,
                           Filter filter)
                    throws java.io.IOException

Modifies features matching filter.

Equivelent to:

 FeatureWriter writer = dataStore.getFeatureWriter( typeName, filter, transaction );
 Feature feature;
 while( writer.hasNext() ){
    feature = writer.next();
    feature.setAttribute( type[0].getName(), value[0] );
    feature.setAttribute( type[1].getName(), value[1] );
    ...
    feature.setAttribute( type[N].getName(), value[N] ); 
    writer.write();
 }
 writer.close();
 
 

Subclasses may override this method to perform the appropriate optimization for this result.

Specified by:

modifyFeatures in interface FeatureStore

Parameters:

type - Attributes to modify

value - Modifications being made to type

filter - Identifies features to modify

Throws:

java.io.IOException

See Also:

FeatureStore.modifyFeatures(org.geotools.feature.AttributeType, java.lang.Object, org.geotools.filter.Filter)

modifyFeatures

protected void modifyFeatures(AttributeType[] type,
                              java.lang.Object[] value,
                              FeatureWriter writer)
                       throws DataSourceException,
                              java.io.IOException

Throws:

DataSourceException

java.io.IOException

addFeatures

public java.util.Set addFeatures(FeatureReader reader)
                          throws java.io.IOException

Add Features from reader to this FeatureStore.

Equivelent to:

 Set set = new HashSet();
 FeatureWriter writer = dataStore.getFeatureWriter( typeName, true, transaction );
 Featrue feature, newFeature;
 while( reader.hasNext() ){
    feature = reader.next();
    newFeature = writer.next();
    newFeature.setAttributes( feature.getAttribtues( null ) );
    writer.write();
    set.add( newfeature.getID() );
 }
 reader.close();
 writer.close();
 
 return set;
 
 

(If you don't have a FeatureReader handy DataUtilities.reader() may be able to help out)

Subclasses may override this method to perform the appropriate optimization for this result.

Specified by:

addFeatures in interface FeatureStore

Parameters:

reader -

Returns:

The Set of FeatureIDs added

Throws:

java.io.IOException

See Also:

FeatureStore.addFeatures(org.geotools.data.FeatureReader)

removeFeatures

public void removeFeatures(Filter filter)
                    throws java.io.IOException

Removes features indicated by provided filter.

Equivelent to:

 FeatureWriter writer = dataStore.getFeatureWriter( typeName, filter, transaction );
 Feature feature;
 while( writer.hasNext() ){
    feature = writer.next();
    writer.remove();
 }
 writer.close();
 
 

Subclasses may override this method to perform the appropriate optimization for this result.

Specified by:

removeFeatures in interface FeatureStore

Parameters:

filter - Identifies features to remove

Throws:

java.io.IOException

See Also:

FeatureStore.modifyFeatures(org.geotools.feature.AttributeType, java.lang.Object, org.geotools.filter.Filter)

setFeatures

public void setFeatures(FeatureReader reader)
                 throws java.io.IOException

Replace with contents of reader.

Equivelent to:

 FeatureWriter writer = dataStore.getFeatureWriter( typeName, false, transaction );
 Feature feature, newFeature;
 while( writer.hasNext() ){
    feature = writer.next();
    writer.remove();
 }
 while( reader.hasNext() ){
    newFeature = reader.next();
    feature = writer.next();
    newFeature.setAttributes( feature.getAttributes( null ) );
    writer.write();
 }
 reader.close();
 writer.close();
 
 

Subclasses may override this method to perform the appropriate optimization for this result.

Specified by:

setFeatures in interface FeatureStore

Parameters:

reader - Contents to replace with

Throws:

java.io.IOException

See Also:

FeatureStore.modifyFeatures(org.geotools.feature.AttributeType, java.lang.Object, org.geotools.filter.Filter)

setTransaction

public void setTransaction(Transaction transaction)

Description copied from interface: FeatureStore

Provides a transaction for commit/rollback control of this FeatureStore.

This method operates as a replacement for setAutoCommitMode. When a transaction is provided you are no longer automatically committing.

In order to return to AutoCommit mode supply the Transaction.AUTO_COMMIT to this method. Since this represents a return to AutoCommit mode the previous Transaction will be commited.

Specified by:

setTransaction in interface FeatureStore

Parameters:

transaction - DOCUMENT ME!