org.deegree.ogcwebservices.wfs.operation
Class GetFeatureWithLock

java.lang.Object
  org.deegree.ogcwebservices.AbstractOGCWebServiceRequest
      org.deegree.ogcwebservices.wfs.operation.AbstractWFSRequest
          org.deegree.ogcwebservices.wfs.operation.GetFeature
              org.deegree.ogcwebservices.wfs.operation.GetFeatureWithLock

All Implemented Interfaces:

Serializable, OGCWebServiceRequest

public class GetFeatureWithLock
extends GetFeature

Represents a GetFeatureWithLock request to a web feature service.

This is identical to a GetFeature request, except that the features matching the request will also be locked.

Version:

$Revision: 6625 $

Author:

Markus Schneider, last edited by: $Author: mschneider $

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.deegree.ogcwebservices.wfs.operation.GetFeature

GetFeature.RESULT_TYPE

Field Summary

Fields inherited from class org.deegree.ogcwebservices.wfs.operation.GetFeature

FORMAT_FEATURECOLLECTION

Fields inherited from class org.deegree.ogcwebservices.wfs.operation.AbstractWFSRequest

FORMAT_GML2, FORMAT_GML2_WFS100, FORMAT_GML3, FORMAT_XML

Constructor Summary

GetFeatureWithLock(String version, String id, String handle, GetFeature.RESULT_TYPE resultType, String outputFormat, int maxFeatures, int startPosition, int traverseXLinkDepth, int traverseXLinkExpiry, Query[] queries, Map<String,String> vendorSpecificParam, long expiry, LockFeature.ALL_SOME_TYPE lockAction)
Creates a new GetFeatureWithLock instance.

Method Summary

static GetFeatureWithLock	create(Map<String,String> kvp) Creates a new GetFeatureWithLock request from the given map.
static GetFeatureWithLock	create(String id, Element root) Creates a new GetFeatureWithLock instance from a document that contains the DOM representation of the request.
static GetFeatureWithLock	create(String id, String request) Creates a new GetFeatureWithLock instance from the given key-value pair encoded request.
static GetFeatureWithLock	create(String version, String id, String handle, GetFeature.RESULT_TYPE resultType, String outputFormat, int maxFeatures, int startPosition, int traverseXLinkDepth, int traverseXLinkExpiry, Query[] queries, Map<String,String> vendorSpecificParam, long expiry, LockFeature.ALL_SOME_TYPE lockAction) Creates a new GetFeatureWithLock instance from the given parameters.
long	getExpiry() Returns the limit on how long the web feature service holds the lock in the event that a transaction is never issued that would release the lock.
LockFeature.ALL_SOME_TYPE	getLockAction() Returns the mode for lock acquisition.

Methods inherited from class org.deegree.ogcwebservices.wfs.operation.GetFeature

create, extractPropNames, getMaxFeatures, getOutputFormat, getQuery, getResultType, getStartPosition, getTraverseXLinkDepth, getTraverseXLinkExpiry, setMaxFeatures, setQueries, toString

Methods inherited from class org.deegree.ogcwebservices.wfs.operation.AbstractWFSRequest

checkServiceParameter, checkVersionParameter, extractBBOXFilter, extractFilters, extractNamespaceParameter, extractTypeNames, getHandle, getServiceName

Methods inherited from class org.deegree.ogcwebservices.AbstractOGCWebServiceRequest

getId, getParam, getParamAsInt, getParamValues, getRequestParameter, getRequiredParam, getVendorSpecificParameter, getVendorSpecificParameters, getVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

GetFeatureWithLock

GetFeatureWithLock(String version,
                   String id,
                   String handle,
                   GetFeature.RESULT_TYPE resultType,
                   String outputFormat,
                   int maxFeatures,
                   int startPosition,
                   int traverseXLinkDepth,
                   int traverseXLinkExpiry,
                   Query[] queries,
                   Map<String,String> vendorSpecificParam,
                   long expiry,
                   LockFeature.ALL_SOME_TYPE lockAction)

Creates a new GetFeatureWithLock instance.

Parameters:

version - request version

id - id of the request

handle -

resultType - desired result type (results | hits)

outputFormat - requested result format

maxFeatures -

startPosition - deegree specific parameter defining where to start considering features

traverseXLinkDepth -

traverseXLinkExpiry -

queries -

vendorSpecificParam -

expiry - the limit on how long the web feature service keeps the lock (in milliseconds)

lockAction - method for lock acquisition

Method Detail

create

public static GetFeatureWithLock create(String version,
                                        String id,
                                        String handle,
                                        GetFeature.RESULT_TYPE resultType,
                                        String outputFormat,
                                        int maxFeatures,
                                        int startPosition,
                                        int traverseXLinkDepth,
                                        int traverseXLinkExpiry,
                                        Query[] queries,
                                        Map<String,String> vendorSpecificParam,
                                        long expiry,
                                        LockFeature.ALL_SOME_TYPE lockAction)

Creates a new GetFeatureWithLock instance from the given parameters.

Parameters:

version - request version

id - id of the request

handle -

resultType - desired result type (results | hits)

outputFormat - requested result format

maxFeatures -

startPosition - deegree specific parameter defining where to start considering features

traverseXLinkDepth -

traverseXLinkExpiry -

queries -

vendorSpecificParam -

expiry - the limit on how long the web feature service keeps the lock (in milliseconds)

lockAction - method for lock acquisition

Returns:

new GetFeatureWithLock request

create

public static GetFeatureWithLock create(String id,
                                        Element root)
                                 throws OGCWebServiceException

Creates a new GetFeatureWithLock instance from a document that contains the DOM representation of the request.

Parameters:

id - of the request

root - element that contains the DOM representation of the request

Returns:

new GetFeatureWithLock request

Throws:

OGCWebServiceException

create

public static GetFeatureWithLock create(String id,
                                        String request)
                                 throws InconsistentRequestException,
                                        InvalidParameterValueException

Creates a new GetFeatureWithLock instance from the given key-value pair encoded request.

Parameters:

id - request identifier

request -

Returns:

new GetFeatureWithLock request

Throws:

InvalidParameterValueException

InconsistentRequestException

create

public static GetFeatureWithLock create(Map<String,String> kvp)
                                 throws InconsistentRequestException,
                                        InvalidParameterValueException

Creates a new GetFeatureWithLock request from the given map.

Parameters:

kvp - key-value pairs, keys have to be uppercase

Returns:

new GetFeatureWithLock request

Throws:

InconsistentRequestException

InvalidParameterValueException

getExpiry

public long getExpiry()

Returns the limit on how long the web feature service holds the lock in the event that a transaction is never issued that would release the lock. The expiry limit is specified in milliseconds.

Returns:

the limit on how long the web feature service holds the lock (in milliseconds)

getLockAction

public LockFeature.ALL_SOME_TYPE getLockAction()

Returns the mode for lock acquisition.

Returns:

the mode for lock acquisition

See Also:

LockFeature.ALL_SOME_TYPE