InsertElementType (b3p-commons-gis 4.2.1 API)

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Insert
```
public class InsertElementType
extends Object
implements Serializable
```
An Insert element may contain a feature collection or one or more feature instances to be inserted into the repository.

Version:

$Revision$ $Date$

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

InsertElementType()

Constructors
Constructor and Description
`InsertElementType()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addFeature(int index, Object vFeature)` Method addFeature
`void`	`addFeature(Object vFeature)` Method addFeature
`void`	`clearFeature()` Method clearFeature
`Enumeration`	`enumerateFeature()` Method enumerateFeature
`Object[]`	`getFeature()` Method getFeature
`Object`	`getFeature(int index)` Method getFeature
`int`	`getFeatureCount()` Method getFeatureCount
`String`	`getHandle()` Returns the value of field 'handle'.
`IdentifierGenerationOptionType`	`getIdgen()` Returns the value of field 'idgen'.
`String`	`getInputFormat()` Returns the value of field 'inputFormat'.
`String`	`getSrsName()` Returns the value of field 'srsName'.
`boolean`	`isValid()` Method isValid
`void`	`marshal(ContentHandler handler)` Method marshal
`void`	`marshal(Writer out)` Method marshal
`boolean`	`removeFeature(Object vFeature)` Method removeFeature
`void`	`setFeature(int index, Object vFeature)` Method setFeature
`void`	`setFeature(Object[] featureArray)` Method setFeature
`void`	`setHandle(String handle)` Sets the value of field 'handle'.
`void`	`setIdgen(IdentifierGenerationOptionType idgen)` Sets the value of field 'idgen'.
`void`	`setInputFormat(String inputFormat)` Sets the value of field 'inputFormat'.
`void`	`setSrsName(String srsName)` Sets the value of field 'srsName'.
`static InsertElementType`	`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

- Constructor Detail
  - InsertElementType
```
public InsertElementType()
```
- Method Detail
  - addFeature
```
public void addFeature(Object vFeature)
                throws IndexOutOfBoundsException
```
    Method addFeature
    
    Parameters:
    vFeature -
    
    Throws:
    
    IndexOutOfBoundsException
  - addFeature
```
public void addFeature(int index,
              Object vFeature)
                throws IndexOutOfBoundsException
```
    Method addFeature
    
    Parameters:
    index -
    vFeature -
    
    Throws:
    
    IndexOutOfBoundsException
  - clearFeature
```
public void clearFeature()
```
    Method clearFeature
  - enumerateFeature
```
public Enumeration enumerateFeature()
```
    Method enumerateFeature
    
    Returns:
    Enumeration
  - getFeature
```
public Object getFeature(int index)
                  throws IndexOutOfBoundsException
```
    Method getFeature
    
    Parameters:
    index -
    
    Returns:
    Object
    
    Throws:
    
    IndexOutOfBoundsException
  - getFeature
```
public Object[] getFeature()
```
    Method getFeature
    
    Returns:
    Object
  - getFeatureCount
```
public int getFeatureCount()
```
    Method getFeatureCount
    
    Returns:
    int
  - 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 Insert 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
  - getIdgen
```
public IdentifierGenerationOptionType getIdgen()
```
    Returns the value of field 'idgen'. The field 'idgen' has the following description: The idgen attribute control how a WFS generates identifiers from newly created feature instances using the Insert action. The default action is to have the WFS generate a new id for the features. This is also backward compatible with WFS 1.0 where the only action was for the WFS to generate an new id.
    
    Returns:
    IdentifierGenerationOptionType
  - 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
  - getSrsName
```
public String getSrsName()
```
    Returns the value of field 'srsName'. The field 'srsName' has the following description: ===== PAV 12NOV2004 ==== WHY IS THIS HERE? WOULDN'T WE KNOW THE INCOMING SRS FROM THE GML GEOMETRY ELEMENTS? I ASSUME THAT IF THE INCOMING SRS DOES NOT MATCH ONE OF THE STORAGE SRS(s) THEN THE WFS WOULD EITHER PROJECT INTO THE STORAGE SRS OR RAISE AN EXCEPTION.
    
    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
  - removeFeature
```
public boolean removeFeature(Object vFeature)
```
    Method removeFeature
    
    Parameters:
    vFeature -
    
    Returns:
    boolean
  - setFeature
```
public void setFeature(int index,
              Object vFeature)
                throws IndexOutOfBoundsException
```
    Method setFeature
    
    Parameters:
    index -
    vFeature -
    
    Throws:
    
    IndexOutOfBoundsException
  - setFeature
```
public void setFeature(Object[] featureArray)
```
    Method setFeature
    
    Parameters:
    featureArray -
  - 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 Insert 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'.
  - setIdgen
```
public void setIdgen(IdentifierGenerationOptionType idgen)
```
    Sets the value of field 'idgen'. The field 'idgen' has the following description: The idgen attribute control how a WFS generates identifiers from newly created feature instances using the Insert action. The default action is to have the WFS generate a new id for the features. This is also backward compatible with WFS 1.0 where the only action was for the WFS to generate an new id.
    
    Parameters:
    idgen - the value of field 'idgen'.
  - 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'.
  - setSrsName
```
public void setSrsName(String srsName)
```
    Sets the value of field 'srsName'. The field 'srsName' has the following description: ===== PAV 12NOV2004 ==== WHY IS THIS HERE? WOULDN'T WE KNOW THE INCOMING SRS FROM THE GML GEOMETRY ELEMENTS? I ASSUME THAT IF THE INCOMING SRS DOES NOT MATCH ONE OF THE STORAGE SRS(s) THEN THE WFS WOULD EITHER PROJECT INTO THE STORAGE SRS OR RAISE AN EXCEPTION.
    
    Parameters:
    srsName - the value of field 'srsName'.
  - unmarshal
```
public static InsertElementType unmarshal(Reader reader)
                                   throws org.exolab.castor.xml.MarshalException,
                                          org.exolab.castor.xml.ValidationException
```
    Method unmarshal
    
    Parameters:
    reader -
    
    Returns:
    InsertElementType
    
    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 InsertElementType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InsertElementType

Method Detail

addFeature

addFeature

clearFeature

enumerateFeature

getFeature

getFeature

getFeatureCount

getHandle

getIdgen

getInputFormat

getSrsName

isValid

marshal

marshal

removeFeature

setFeature

setFeature

setHandle

setIdgen

setInputFormat

setSrsName

unmarshal

validate