UpdateElementType (b3p-commons-gis 4.2.1 API)

java.lang.Object
- nl.b3p.xml.wfs.v110.UpdateElementType

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Update
```
public class UpdateElementType
extends Object
implements Serializable
```
Class UpdateElementType.

Version:

$Revision$ $Date$

See Also:
Serialized Form

Property Summary

Properties
Type Property and Description

Enumeration enumerate
Method enumerateProperty

Properties
Type	Property and Description
`Enumeration`	`enumerate` Method enumerateProperty

Constructor Summary

Constructors
Constructor and Description

UpdateElementType()

Constructors
Constructor and Description
`UpdateElementType()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addProperty(int index, Property vProperty)` Method addProperty
`void`	`addProperty(Property vProperty)` Method addProperty
`void`	`clearProperty()` Method clearProperty
`Enumeration`	`enumerateProperty()` Method enumerateProperty
`Filter`	`getFilter()` Returns the value of field 'filter'.
`String`	`getHandle()` Returns the value of field 'handle'.
`String`	`getInputFormat()` Returns the value of field 'inputFormat'.
`Property[]`	`getProperty()` Method getProperty
`Property`	`getProperty(int index)` Method getProperty
`int`	`getPropertyCount()` Method getPropertyCount
`String`	`getSrsName()` Returns the value of field 'srsName'.
`String`	`getTypeName()` Returns the value of field 'typeName'.
`boolean`	`isValid()` Method isValid
`void`	`marshal(ContentHandler handler)` Method marshal
`void`	`marshal(Writer out)` Method marshal
`boolean`	`removeProperty(Property vProperty)` Method removeProperty
`void`	`setFilter(Filter filter)` Sets the value of field 'filter'.
`void`	`setHandle(String handle)` Sets the value of field 'handle'.
`void`	`setInputFormat(String inputFormat)` Sets the value of field 'inputFormat'.
`void`	`setProperty(int index, Property vProperty)` Method setProperty
`void`	`setProperty(Property[] propertyArray)` Method setProperty
`void`	`setSrsName(String srsName)` Sets the value of field 'srsName'.
`void`	`setTypeName(String typeName)` Sets the value of field 'typeName'.
`static UpdateElementType`	`unmarshal(Reader reader)` Method unmarshal
`void`	`validate()` Method validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - enumerate
    
    Method enumerateProperty
    
    Returns:
    Enumeration
- Constructor Detail
  - UpdateElementType
```
public UpdateElementType()
```
- Method Detail
  - addProperty
```
public void addProperty(Property vProperty)
                 throws IndexOutOfBoundsException
```
    Method addProperty
    
    Parameters:
    vProperty -
    
    Throws:
    
    IndexOutOfBoundsException
  - addProperty
```
public void addProperty(int index,
               Property vProperty)
                 throws IndexOutOfBoundsException
```
    Method addProperty
    
    Parameters:
    index -
    vProperty -
    
    Throws:
    
    IndexOutOfBoundsException
  - clearProperty
```
public void clearProperty()
```
    Method clearProperty
  - enumerateProperty
```
public Enumeration enumerateProperty()
```
    Method enumerateProperty
    
    Returns:
    Enumeration
  - getFilter
```
public Filter getFilter()
```
    Returns the value of field 'filter'. The field 'filter' has the following description: The Filter element is used to constrain the scope of the update operation to those features identified by the filter. Feature instances can be specified explicitly and individually using the identifier of each feature instance OR a set of features to be operated on can be identified by specifying spatial and non-spatial constraints in the filter. If no filter is specified then update operation applies to all feature instances.
    
    Returns:
    Filter
  - getHandle
```
public String getHandle()
```
    Returns the value of field 'handle'. The field 'handle' has the following description: The handle attribute allows a client application to assign a client-generated request identifier to an Insert action. The handle is included to facilitate error reporting. If an Update action in a Transaction request fails, then a WFS may include the handle in an exception report to localize the error. If no handle is included of the offending Insert element then a WFS may employee other means of localizing the error (e.g. line number).
    
    Returns:
    String
  - getInputFormat
```
public String getInputFormat()
```
    Returns the value of field 'inputFormat'. The field 'inputFormat' has the following description: This inputFormat attribute is used to indicate the format used to encode a feature instance in an Insert element. The default value of 'text/xml; subtype=gml/3.1.1' is used to indicate that feature encoding is GML3. Another example might be 'text/xml; subtype=gml/2.1.2' indicating that the feature us encoded in GML2. A WFS must declare in the capabilities document, using a Parameter element, which version of GML it supports.
    
    Returns:
    String
  - getProperty
```
public Property getProperty(int index)
                     throws IndexOutOfBoundsException
```
    Method getProperty
    
    Parameters:
    index -
    
    Returns:
    Property
    
    Throws:
    
    IndexOutOfBoundsException
  - getProperty
```
public Property[] getProperty()
```
    Method getProperty
    
    Returns:
    Property
  - getPropertyCount
```
public int getPropertyCount()
```
    Method getPropertyCount
    
    Returns:
    int
  - getSrsName
```
public String getSrsName()
```
    Returns the value of field 'srsName'. The field 'srsName' has the following description: DO WE NEED THIS HERE?
    
    Returns:
    String
  - getTypeName
```
public String getTypeName()
```
    Returns the value of field 'typeName'. The field 'typeName' has the following description: The value of the typeName attribute is the name of the feature type to be updated. The name specified must be a valid type that belongs to the feature content as defined by the GML Application Schema.
    
    Returns:
    String
  - isValid
```
public boolean isValid()
```
    Method isValid
    
    Returns:
    boolean
  - marshal
```
public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
```
    Method marshal
    
    Parameters:
    out -
    
    Throws:
    
    org.exolab.castor.xml.MarshalException
    
    org.exolab.castor.xml.ValidationException
  - marshal
```
public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
```
    Method marshal
    
    Parameters:
    handler -
    
    Throws:
    
    IOException
    
    org.exolab.castor.xml.MarshalException
    
    org.exolab.castor.xml.ValidationException
  - removeProperty
```
public boolean removeProperty(Property vProperty)
```
    Method removeProperty
    
    Parameters:
    vProperty -
    
    Returns:
    boolean
  - setFilter
```
public void setFilter(Filter filter)
```
    Sets the value of field 'filter'. The field 'filter' has the following description: The Filter element is used to constrain the scope of the update operation to those features identified by the filter. Feature instances can be specified explicitly and individually using the identifier of each feature instance OR a set of features to be operated on can be identified by specifying spatial and non-spatial constraints in the filter. If no filter is specified then update operation applies to all feature instances.
    
    Parameters:
    filter - the value of field 'filter'.
  - setHandle
```
public void setHandle(String handle)
```
    Sets the value of field 'handle'. The field 'handle' has the following description: The handle attribute allows a client application to assign a client-generated request identifier to an Insert action. The handle is included to facilitate error reporting. If an Update action in a Transaction request fails, then a WFS may include the handle in an exception report to localize the error. If no handle is included of the offending Insert element then a WFS may employee other means of localizing the error (e.g. line number).
    
    Parameters:
    handle - the value of field 'handle'.
  - setInputFormat
```
public void setInputFormat(String inputFormat)
```
    Sets the value of field 'inputFormat'. The field 'inputFormat' has the following description: This inputFormat attribute is used to indicate the format used to encode a feature instance in an Insert element. The default value of 'text/xml; subtype=gml/3.1.1' is used to indicate that feature encoding is GML3. Another example might be 'text/xml; subtype=gml/2.1.2' indicating that the feature us encoded in GML2. A WFS must declare in the capabilities document, using a Parameter element, which version of GML it supports.
    
    Parameters:
    inputFormat - the value of field 'inputFormat'.
  - setProperty
```
public void setProperty(int index,
               Property vProperty)
                 throws IndexOutOfBoundsException
```
    Method setProperty
    
    Parameters:
    index -
    vProperty -
    
    Throws:
    
    IndexOutOfBoundsException
  - setProperty
```
public void setProperty(Property[] propertyArray)
```
    Method setProperty
    
    Parameters:
    propertyArray -
  - setSrsName
```
public void setSrsName(String srsName)
```
    Sets the value of field 'srsName'. The field 'srsName' has the following description: DO WE NEED THIS HERE?
    
    Parameters:
    srsName - the value of field 'srsName'.
  - setTypeName
```
public void setTypeName(String typeName)
```
    Sets the value of field 'typeName'. The field 'typeName' has the following description: The value of the typeName attribute is the name of the feature type to be updated. The name specified must be a valid type that belongs to the feature content as defined by the GML Application Schema.
    
    Parameters:
    typeName - the value of field 'typeName'.
  - unmarshal
```
public static UpdateElementType unmarshal(Reader reader)
                                   throws org.exolab.castor.xml.MarshalException,
                                          org.exolab.castor.xml.ValidationException
```
    Method unmarshal
    
    Parameters:
    reader -
    
    Returns:
    UpdateElementType
    
    Throws:
    
    org.exolab.castor.xml.MarshalException
    
    org.exolab.castor.xml.ValidationException
  - validate
```
public void validate()
              throws org.exolab.castor.xml.ValidationException
```
    Method validate
    
    Throws:
    
    org.exolab.castor.xml.ValidationException

Class UpdateElementType

Property Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

enumerate

Constructor Detail

UpdateElementType

Method Detail

addProperty

addProperty

clearProperty

enumerateProperty

getFilter

getHandle

getInputFormat

getProperty

getProperty

getPropertyCount

getSrsName

getTypeName

isValid

marshal

marshal

removeProperty

setFilter

setHandle

setInputFormat

setProperty

setProperty

setSrsName

setTypeName

unmarshal

validate