org.geotools.data
Class AbstractFeatureLocking

java.lang.Object
  extended by org.geotools.data.AbstractFeatureSource
      extended by org.geotools.data.AbstractFeatureStore
          extended by org.geotools.data.AbstractFeatureLocking
All Implemented Interfaces:
FeatureLocking<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>, FeatureSource<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>, FeatureStore<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>
Direct Known Subclasses:
PropertyFeatureSource, ShapefileFeatureLocking

public abstract class AbstractFeatureLocking
extends AbstractFeatureStore
implements FeatureLocking<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>

A Starting point for your own FeatureLocking implementations.

This class extends AbstractFeatureSource and depends on getDataStore().

The implementation of the following functions depends on getDataStore().getLockingManger() not being null:

FeatureStores that have provided their own locking to will need to override the above methods, or provide a custom LockingManger.

Author:
Jody Garnett, Refractions Research

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.geotools.data.FeatureLocking
FeatureLocking.Response
 
Field Summary
 
Fields inherited from class org.geotools.data.AbstractFeatureStore
transaction
 
Fields inherited from class org.geotools.data.AbstractFeatureSource
hints, queryCapabilities
 
Constructor Summary
AbstractFeatureLocking()
           
AbstractFeatureLocking(java.util.Set hints)
          This constructors allows to set the supported hints
 
Method Summary
 int lockFeatures()
          Lock all Features
 int lockFeatures(org.opengis.filter.Filter filter)
          Lock features matching filter.
 int lockFeatures(Query query)
          Lock features matching Query.
 void setFeatureLock(FeatureLock lock)
          Provide a FeatureLock for locking opperations to opperate against.
 void unLockFeatures()
          Unlock all Features.
 void unLockFeatures(org.opengis.filter.Filter filter)
          Unlock Features specified by filter.
 void unLockFeatures(Query query)
          Unlock features specified by the query.
 
Methods inherited from class org.geotools.data.AbstractFeatureStore
addFeatures, addFeatures, getTransaction, modifyFeatures, modifyFeatures, removeFeatures, setFeatures, setTransaction
 
Methods inherited from class org.geotools.data.AbstractFeatureSource
getBounds, getBounds, getCount, getDataStore, getFeatures, getFeatures, getFeatures, getInfo, getName, getQueryCapabilities, getSupportedHints, namedQuery
 
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.FeatureStore
addFeatures, getTransaction, modifyFeatures, modifyFeatures, removeFeatures, setFeatures, setTransaction
 
Methods inherited from interface org.geotools.data.FeatureSource
addFeatureListener, getBounds, getBounds, getCount, getDataStore, getFeatures, getFeatures, getFeatures, getInfo, getName, getQueryCapabilities, getSchema, getSupportedHints, removeFeatureListener
 

Constructor Detail

AbstractFeatureLocking

public AbstractFeatureLocking()

AbstractFeatureLocking

public AbstractFeatureLocking(java.util.Set hints)
This constructors allows to set the supported hints

Parameters:
hints -
Method Detail

setFeatureLock

public void setFeatureLock(FeatureLock lock)
Provide a FeatureLock for locking opperations to opperate against.

Initial Transactional duration locks can be restored with setFeatureLock( FetaureLock.TRANSACTION )

Specified by:
setFeatureLock in interface FeatureLocking<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>
Parameters:
lock - FeatureLock (or FeatureLock.TRANSACTION );
Throws:
java.lang.NullPointerException - If lock was null
See Also:
FeatureLocking.setFeatureLock(org.geotools.data.FeatureLock)

lockFeatures

public int lockFeatures()
                 throws java.io.IOException
Lock all Features

Specified by:
lockFeatures in interface FeatureLocking<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>
Returns:
Number of Locked features
Throws:
java.io.IOException
See Also:
FeatureLocking.lockFeatures()

lockFeatures

public int lockFeatures(org.opengis.filter.Filter filter)
                 throws java.io.IOException
Lock features matching filter.

Specified by:
lockFeatures in interface FeatureLocking<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>
Parameters:
filter -
Returns:
Number of locked Features
Throws:
java.io.IOException

lockFeatures

public int lockFeatures(Query query)
                 throws java.io.IOException
Lock features matching Query.

FeatureStores that have provided their own locking to will need to override this method.

Specified by:
lockFeatures in interface FeatureLocking<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>
Parameters:
query -
Returns:
Number of locked Features
Throws:
java.io.IOException - If we could not determine which feature to lock based on Query
java.lang.UnsupportedOperationException - When DataStore does not provide a LockingManager
DataSourceException - If feature to be locked does not exist
See Also:
FeatureLocking.lockFeatures(org.geotools.data.Query)

unLockFeatures

public void unLockFeatures()
                    throws java.io.IOException
Unlock all Features.

Specified by:
unLockFeatures in interface FeatureLocking<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>
Throws:
java.io.IOException
See Also:
FeatureLocking.unLockFeatures()

unLockFeatures

public void unLockFeatures(org.opengis.filter.Filter filter)
                    throws java.io.IOException
Unlock Features specified by filter.

Specified by:
unLockFeatures in interface FeatureLocking<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>
Parameters:
filter -
Throws:
java.io.IOException

unLockFeatures

public void unLockFeatures(Query query)
                    throws java.io.IOException
Unlock features specified by the query.

FeatureStores that have provided their own locking to will need to override this method.

Specified by:
unLockFeatures in interface FeatureLocking<org.opengis.feature.simple.SimpleFeatureType,org.opengis.feature.simple.SimpleFeature>
Parameters:
query -
Throws:
java.io.IOException
java.lang.UnsupportedOperationException - If lockingManager is not provided by DataStore subclass
DataSourceException - Filter describes an unlocked Feature, or authorization not held
See Also:
FeatureLocking.unLockFeatures(org.geotools.data.Query)


Copyright © 1996-2010 Geotools. All Rights Reserved.