org.vfny.geoserver.requests.wfs
Class DeleteRequest

java.lang.Object
  extended byorg.vfny.geoserver.requests.wfs.SubTransactionRequest
      extended byorg.vfny.geoserver.requests.wfs.DeleteRequest

public class DeleteRequest
extends SubTransactionRequest

Defines a WFS Delete request, an element of TransactionRequest.

Defines a WFS delete request, which is a type transaction request. Full transaction requests may contain one or more delete requests. Note that this delete request object is slightly different than it is defined in the WFS 1.0 specification. In the specification, the delete request may contain one or more filters and feature types for deletion. In this construction - for consistency - each delete request may contain only a single feature type delete operation and filter. This rationalizes the design of the transaction object (which contains one or more sub requests) and its children requests, which contain only a single operation.

Each delete request contains a type name, (optionally) a filter, and (optionally) a release all boolean. Release all defines the action to preform on feature locks. If it is specified as true, then all feature locks are released when the transaction terminates. If it is specified as false, only those records that are modified are released.


Field Summary
protected  org.geotools.filter.Filter filter
          Specifies the features to lock.
protected  boolean releaseAll
           
protected  java.lang.String typeName
          Specifies the output format
 
Fields inherited from class org.vfny.geoserver.requests.wfs.SubTransactionRequest
DELETE, handle, INSERT, UPDATE
 
Constructor Summary
DeleteRequest()
          Empty constructor.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 org.geotools.filter.Filter getFilter()
          Gets the filter of what features should be returned.
 java.lang.String getOperation()
          Returns what type of transaction operation this is.
 short getOpType()
          Gets the short representation of this operation.
 boolean getReleaseAll()
          Gets whether all locks should be released after this transaction.
 java.lang.String getTypeName()
          Gets the Name of the FeatureTypeInfo for this request.
 void setFilter(org.geotools.filter.Filter filter)
          Sets the filter of what features should be returned.
 void setReleaseAll(boolean releaseAll)
          Sets whether all locks should be released after this transaction.
 void setTypeName(java.lang.String typeName)
          Sets the name of type to delete.
 java.lang.String toString()
          Override of toString().
 
Methods inherited from class org.vfny.geoserver.requests.wfs.SubTransactionRequest
getHandle, setHandle
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

typeName

protected java.lang.String typeName
Specifies the output format


filter

protected org.geotools.filter.Filter filter
Specifies the features to lock.


releaseAll

protected boolean releaseAll
Constructor Detail

DeleteRequest

public DeleteRequest()
Empty constructor.

Method Detail

getTypeName

public java.lang.String getTypeName()
Gets the Name of the FeatureTypeInfo for this request.

Overrides:
getTypeName in class SubTransactionRequest
Returns:
The feature type name.

setTypeName

public void setTypeName(java.lang.String typeName)
Sets the name of type to delete.

Overrides:
setTypeName in class SubTransactionRequest
Parameters:
typeName - The feature type name.

getFilter

public org.geotools.filter.Filter getFilter()
Gets the filter of what features should be returned.

Returns:
The geotools filter to query against.

setFilter

public void setFilter(org.geotools.filter.Filter filter)
Sets the filter of what features should be returned.

Overrides:
setFilter in class SubTransactionRequest
Parameters:
filter - The geotools filter to query against.

getReleaseAll

public boolean getReleaseAll()
Gets whether all locks should be released after this transaction.

Returns:
true if all locks should be released.

setReleaseAll

public void setReleaseAll(boolean releaseAll)
Sets whether all locks should be released after this transaction.

Parameters:
releaseAll - if all locks should be released.

getOperation

public java.lang.String getOperation()
Returns what type of transaction operation this is.

Returns:
the string "Delete"

getOpType

public short getOpType()
Gets the short representation of this operation.

Specified by:
getOpType in class SubTransactionRequest
Returns:
the short representation of delete.

toString

public java.lang.String toString()
Override of toString().

Returns:
a string representation of this delete request.

equals

public boolean equals(java.lang.Object obj)