GetFeatureType (b3p-commons-gis 7.1 API)

java.lang.Object
- nl.b3p.xml.wfs.v100.GetFeatureType

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GetFeature
```
public class GetFeatureType
extends Object
implements Serializable
```
A GetFeature element contains one or more Query elements that describe a query operation on one feature type. In response to a GetFeature request, a Web Feature Service must be able to generate a GML2 response that validates using a schema generated by the DescribeFeatureType request. A Web Feature Service may support other possibly non-XML (and even binary) output formats as long as those formats are advertised in the capabilities document.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetFeatureType()

Constructors
Constructor and Description
`GetFeatureType()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addQuery(int index, Query vQuery)` Method addQuery
`void`	`addQuery(Query vQuery)` Method addQuery
`void`	`clearQuery()` Method clearQuery
`void`	`deleteMaxFeatures()` Method deleteMaxFeatures
`Enumeration`	`enumerateQuery()` Method enumerateQuery
`String`	`getHandle()` Returns the value of field 'handle'.
`int`	`getMaxFeatures()` Returns the value of field 'maxFeatures'.
`String`	`getOutputFormat()` Returns the value of field 'outputFormat'.
`Query[]`	`getQuery()` Method getQuery
`Query`	`getQuery(int index)` Method getQuery
`int`	`getQueryCount()` Method getQueryCount
`String`	`getService()` Returns the value of field 'service'.
`String`	`getVersion()` Returns the value of field 'version'.
`boolean`	`hasMaxFeatures()` Method hasMaxFeatures
`boolean`	`isValid()` Method isValid
`void`	`marshal(ContentHandler handler)` Method marshal
`void`	`marshal(Writer out)` Method marshal
`boolean`	`removeQuery(Query vQuery)` Method removeQuery
`void`	`setHandle(String handle)` Sets the value of field 'handle'.
`void`	`setMaxFeatures(int maxFeatures)` Sets the value of field 'maxFeatures'.
`void`	`setOutputFormat(String outputFormat)` Sets the value of field 'outputFormat'.
`void`	`setQuery(int index, Query vQuery)` Method setQuery
`void`	`setQuery(Query[] queryArray)` Method setQuery
`void`	`setService(String service)` Sets the value of field 'service'.
`void`	`setVersion(String version)` Sets the value of field 'version'.
`static GetFeatureType`	`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
  - GetFeatureType
```
public GetFeatureType()
```
- Method Detail
  - addQuery
```
public void addQuery(Query vQuery)
              throws IndexOutOfBoundsException
```
    Method addQuery
    
    Parameters:
    
    vQuery -
    
    Throws:
    
    IndexOutOfBoundsException
  - addQuery
```
public void addQuery(int index,
                     Query vQuery)
              throws IndexOutOfBoundsException
```
    Method addQuery
    
    Parameters:
    
    index -
    
    vQuery -
    
    Throws:
    
    IndexOutOfBoundsException
  - clearQuery
```
public void clearQuery()
```
    Method clearQuery
  - deleteMaxFeatures
```
public void deleteMaxFeatures()
```
    Method deleteMaxFeatures
  - enumerateQuery
```
public Enumeration enumerateQuery()
```
    Method enumerateQuery
    
    Returns:
    
    Enumeration
  - getHandle
```
public String getHandle()
```
    Returns the value of field 'handle'.
    
    Returns:
    
    String
  - getMaxFeatures
```
public int getMaxFeatures()
```
    Returns the value of field 'maxFeatures'. The field 'maxFeatures' has the following description: The maxFeatures attribute is used to specify the maximum number of features that a GetFeature operation should generate (regardless of the actual number of query hits).
    
    Returns:
    
    int
  - getOutputFormat
```
public String getOutputFormat()
```
    Returns the value of field 'outputFormat'. The field 'outputFormat' has the following description: The outputFormat attribute is used to specify the output format that the Web Feature Service should generate in response to a GetFeature or GetFeatureWithLock element. The default value of GML2 indicates that the output is an XML document that conforms to the Geography Markup Language (GML) Implementation Specification V2.0. Other values may be used to specify other formats as long as those values are advertised in the capabilities document. For example, the value WKB may be used to indicate that a Well Known Binary format be used to encode the output.
    
    Returns:
    
    String
  - getQuery
```
public Query getQuery(int index)
               throws IndexOutOfBoundsException
```
    Method getQuery
    
    Parameters:
    
    index -
    
    Returns:
    
    Query
    
    Throws:
    
    IndexOutOfBoundsException
  - getQuery
```
public Query[] getQuery()
```
    Method getQuery
    
    Returns:
    
    Query
  - getQueryCount
```
public int getQueryCount()
```
    Method getQueryCount
    
    Returns:
    
    int
  - getService
```
public String getService()
```
    Returns the value of field 'service'.
    
    Returns:
    
    String
  - getVersion
```
public String getVersion()
```
    Returns the value of field 'version'.
    
    Returns:
    
    String
  - hasMaxFeatures
```
public boolean hasMaxFeatures()
```
    Method hasMaxFeatures
    
    Returns:
    
    boolean
  - 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
  - removeQuery
```
public boolean removeQuery(Query vQuery)
```
    Method removeQuery
    
    Parameters:
    
    vQuery -
    
    Returns:
    
    boolean
  - setHandle
```
public void setHandle(String handle)
```
    Sets the value of field 'handle'.
    
    Parameters:
    
    handle - the value of field 'handle'.
  - setMaxFeatures
```
public void setMaxFeatures(int maxFeatures)
```
    Sets the value of field 'maxFeatures'. The field 'maxFeatures' has the following description: The maxFeatures attribute is used to specify the maximum number of features that a GetFeature operation should generate (regardless of the actual number of query hits).
    
    Parameters:
    
    maxFeatures - the value of field 'maxFeatures'.
  - setOutputFormat
```
public void setOutputFormat(String outputFormat)
```
    Sets the value of field 'outputFormat'. The field 'outputFormat' has the following description: The outputFormat attribute is used to specify the output format that the Web Feature Service should generate in response to a GetFeature or GetFeatureWithLock element. The default value of GML2 indicates that the output is an XML document that conforms to the Geography Markup Language (GML) Implementation Specification V2.0. Other values may be used to specify other formats as long as those values are advertised in the capabilities document. For example, the value WKB may be used to indicate that a Well Known Binary format be used to encode the output.
    
    Parameters:
    
    outputFormat - the value of field 'outputFormat'.
  - setQuery
```
public void setQuery(int index,
                     Query vQuery)
              throws IndexOutOfBoundsException
```
    Method setQuery
    
    Parameters:
    
    index -
    
    vQuery -
    
    Throws:
    
    IndexOutOfBoundsException
  - setQuery
```
public void setQuery(Query[] queryArray)
```
    Method setQuery
    
    Parameters:
    
    queryArray -
  - setService
```
public void setService(String service)
```
    Sets the value of field 'service'.
    
    Parameters:
    
    service - the value of field 'service'.
  - setVersion
```
public void setVersion(String version)
```
    Sets the value of field 'version'.
    
    Parameters:
    
    version - the value of field 'version'.
  - unmarshal
```
public static GetFeatureType unmarshal(Reader reader)
                                throws org.exolab.castor.xml.MarshalException,
                                       org.exolab.castor.xml.ValidationException
```
    Method unmarshal
    
    Parameters:
    
    reader -
    
    Returns:
    
    GetFeatureType
    
    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 GetFeatureType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GetFeatureType

Method Detail

addQuery

addQuery

clearQuery

deleteMaxFeatures

enumerateQuery

getHandle

getMaxFeatures

getOutputFormat

getQuery

getQuery

getQueryCount

getService

getVersion

hasMaxFeatures

isValid

marshal

marshal

removeQuery

setHandle

setMaxFeatures

setOutputFormat

setQuery

setQuery

setService

setVersion

unmarshal

validate