deegree-core-3.0-pre-nightly (2010/03/05 00:01) - official

org.deegree.protocol.wfs.transaction
Class Native

java.lang.Object
  extended by org.deegree.protocol.wfs.transaction.TransactionOperation
      extended by org.deegree.protocol.wfs.transaction.Native

public class Native
extends TransactionOperation

Represents a WFS Native operation (part of a Transaction request).

Version:
$Revision: 20493 $, $Date: 2009-10-30 15:16:34 +0100 (Fr, 30 Okt 2009) $
Author:
Markus Schneider , last edited by: $Author: mschneider $
See Also:
Transaction

Nested Class Summary
 
Nested classes/interfaces inherited from class org.deegree.protocol.wfs.transaction.TransactionOperation
TransactionOperation.Type
 
Constructor Summary
Native(String handle, String vendorId, boolean safeToIgnore, XMLStreamReader vendorSpecificData)
          Creates a new Native instance.
 
Method Summary
 TransactionOperation.Type getType()
          Always returns TransactionOperation.Type.NATIVE.
 String getVendorId()
          Returns the vendor identifier.
 XMLStreamReader getVendorSpecificData()
          Returns an XMLStreamReader that provides access to the vendor specific data.
 boolean isSafeToIgnore()
          Returns whether the whole transaction request should fail if the operation can not be executed.
 
Methods inherited from class org.deegree.protocol.wfs.transaction.TransactionOperation
getHandle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Native

public Native(String handle,
              String vendorId,
              boolean safeToIgnore,
              XMLStreamReader vendorSpecificData)
Creates a new Native instance.

Parameters:
handle - identifier for the operation, can be null
vendorId - vendor identifier
safeToIgnore - true, if the operation may be ignored without problems, false if the surrounding request depends on it (and must fail if the native operation cannot be executed)
vendorSpecificData - provides access to the XML encoded vendor specific data, cursor must point at the START_ELEMENT event of the wfs:Native element, must not be null
Method Detail

getType

public TransactionOperation.Type getType()
Always returns TransactionOperation.Type.NATIVE.

Specified by:
getType in class TransactionOperation
Returns:
TransactionOperation.Type.NATIVE

getVendorId

public String getVendorId()
Returns the vendor identifier.

Returns:
the vendor identifier.

isSafeToIgnore

public boolean isSafeToIgnore()
Returns whether the whole transaction request should fail if the operation can not be executed.

Returns:
true, if the operation may be ignored safely, false otherwise

getVendorSpecificData

public XMLStreamReader getVendorSpecificData()
Returns an XMLStreamReader that provides access to the vendor specific data.

NOTE: The client must read this stream exactly once and exactly up to the next tag event after the closing element of the feature/feature collection, i.e. the END_ELEMENT of the surrounding Native element.

Returns:
XML encoded vendor specific data, cursor points at the START_ELEMENT event of the wfs:Native element, never null

deegree-core-3.0-pre-nightly (2010/03/05 00:01) - official

an open source project founded by lat/lon, Bonn, Germany.
For more information visit: http://www.deegree.org

]]>