org.geotools.data
Class AbstractFeatureLocking

java.lang.Object
  org.geotools.data.AbstractFeatureSource
      org.geotools.data.AbstractFeatureStore
          org.geotools.data.AbstractFeatureLocking

All Implemented Interfaces:

FeatureLocking, FeatureSource, FeatureStore

Direct Known Subclasses:

PropertyFeatureSource

public abstract class AbstractFeatureLocking

extends AbstractFeatureStore

implements FeatureLocking

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:

• lockFeatures( Query )
• unLockFeatures( Query )
• releaseLock( AuthorizationID )
• refreshLock( AuthorizationID )

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 inherited from class org.geotools.data.FeatureLocking

FeatureLocking.Response

Field Summary

Fields inherited from class org.geotools.data.AbstractFeatureStore

transaction

Constructor Summary

AbstractFeatureLocking()

Method Summary

int	lockFeatures() Lock all Features
int	lockFeatures(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(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, getTransaction, modifyFeatures, modifyFeatures, removeFeatures, setFeatures, setTransaction

Methods inherited from class org.geotools.data.AbstractFeatureSource

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

Constructor Detail

AbstractFeatureLocking

public AbstractFeatureLocking()

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

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

Returns:

Number of Locked features

Throws:

java.io.IOException

See Also:

FeatureLocking.lockFeatures()

lockFeatures

public int lockFeatures(Filter filter)
                 throws java.io.IOException

Lock features matching filter.

Specified by:

lockFeatures in interface FeatureLocking

Parameters:

filter -

Returns:

Number of locked Features

Throws:

java.io.IOException

See Also:

FeatureLocking.lockFeatures(org.geotools.filter.Filter)

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

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

Throws:

java.io.IOException

See Also:

FeatureLocking.unLockFeatures()

unLockFeatures

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

Unlock Features specified by filter.

Specified by:

unLockFeatures in interface FeatureLocking

Parameters:

filter -

Throws:

java.io.IOException

See Also:

FeatureLocking.unLockFeatures(org.geotools.filter.Filter)

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

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)