GetFeatureType (b3p-commons-gis 4.2.9 API)

java.lang.Object
- nl.b3p.ogc.wfs.v110.BaseRequestType
- - nl.b3p.ogc.wfs.v110.GetFeatureType

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GetFeature
```
public class GetFeatureType
extends BaseRequestType
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 GML3 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

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
`void`	`deleteTraverseXlinkExpiry()` Method deleteTraverseXlinkExpiry
`Enumeration`	`enumerateQuery()` Method enumerateQuery
`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`	`getResultType()` Returns the value of field 'resultType'.
`String`	`getTraverseXlinkDepth()` Returns the value of field 'traverseXlinkDepth'.
`int`	`getTraverseXlinkExpiry()` Returns the value of field 'traverseXlinkExpiry'.
`boolean`	`hasMaxFeatures()` Method hasMaxFeatures
`boolean`	`hasTraverseXlinkExpiry()` Method hasTraverseXlinkExpiry
`boolean`	`isValid()` Method isValid
`void`	`marshal(ContentHandler handler)` Method marshal
`void`	`marshal(Writer out)` Method marshal
`boolean`	`removeQuery(Query vQuery)` Method removeQuery
`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`	`setResultType(String resultType)` Sets the value of field 'resultType'.
`void`	`setTraverseXlinkDepth(String traverseXlinkDepth)` Sets the value of field 'traverseXlinkDepth'.
`void`	`setTraverseXlinkExpiry(int traverseXlinkExpiry)` Sets the value of field 'traverseXlinkExpiry'.
`static BaseRequestType`	`unmarshal(Reader reader)` Method unmarshal
`void`	`validate()` Method validate

Methods inherited from class nl.b3p.ogc.wfs.v110.BaseRequestType
getHandle, getService, getVersion, setHandle, setService, setVersion

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
  - deleteTraverseXlinkExpiry
```
public void deleteTraverseXlinkExpiry()
```
    Method deleteTraverseXlinkExpiry
  - enumerateQuery
```
public Enumeration enumerateQuery()
```
    Method enumerateQuery
    
    Returns:
    Enumeration
  - 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 'text/xml; subtype=gml/3.1.1' indicates that the output is an XML document that conforms to the Geography Markup Language (GML) Implementation Specification V3.1.1. For the purposes of experimentation, vendor extension, or even extensions that serve a specific community of interest, other acceptable output format 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
  - getResultType
```
public String getResultType()
```
    Returns the value of field 'resultType'. The field 'resultType' has the following description: The resultType attribute is used to indicate what response a WFS should return to user once a GetFeature request is processed. Possible values are: results - meaning that the full response set (i.e. all the feature instances) should be returned. hits - meaning that an empty response set should be returned (i.e. no feature instances should be returned) but the "numberOfFeatures" attribute should be set to the number of feature instances that would be returned.
    
    Returns:
    String
  - getTraverseXlinkDepth
```
public String getTraverseXlinkDepth()
```
    Returns the value of field 'traverseXlinkDepth'. The field 'traverseXlinkDepth' has the following description: This attribute indicates the depth to which nested property XLink linking element locator attribute (href) XLinks are traversed and resolved if possible. A value of "1" indicates that one linking element locator attribute (href) Xlink will be traversed and the referenced element returned if possible, but nested property XLink linking element locator attribute (href) XLinks in the returned element are not traversed. A value of "*" indicates that all nested property XLink linking element locator attribute (href) XLinks will be traversed and the referenced elements returned if possible. The range of valid values for this attribute consists of positive integers plus "*". If this attribute is not specified then no xlinks shall be resolved and the value of traverseXlinkExpiry attribute (if it specified) may be ignored.
    
    Returns:
    String
  - getTraverseXlinkExpiry
```
public int getTraverseXlinkExpiry()
```
    Returns the value of field 'traverseXlinkExpiry'. The field 'traverseXlinkExpiry' has the following description: The traverseXlinkExpiry attribute value is specified in minutes. It indicates how long a Web Feature Service should wait to receive a response to a nested GetGmlObject request. This attribute is only relevant if a value is specified for the traverseXlinkDepth attribute.
    
    Returns:
    int
  - hasMaxFeatures
```
public boolean hasMaxFeatures()
```
    Method hasMaxFeatures
    
    Returns:
    boolean
  - hasTraverseXlinkExpiry
```
public boolean hasTraverseXlinkExpiry()
```
    Method hasTraverseXlinkExpiry
    
    Returns:
    boolean
  - isValid
```
public boolean isValid()
```
    Method isValid
    
    Overrides:
    
    isValid in class BaseRequestType
    
    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
  - 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 'text/xml; subtype=gml/3.1.1' indicates that the output is an XML document that conforms to the Geography Markup Language (GML) Implementation Specification V3.1.1. For the purposes of experimentation, vendor extension, or even extensions that serve a specific community of interest, other acceptable output format 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 -
  - setResultType
```
public void setResultType(String resultType)
```
    Sets the value of field 'resultType'. The field 'resultType' has the following description: The resultType attribute is used to indicate what response a WFS should return to user once a GetFeature request is processed. Possible values are: results - meaning that the full response set (i.e. all the feature instances) should be returned. hits - meaning that an empty response set should be returned (i.e. no feature instances should be returned) but the "numberOfFeatures" attribute should be set to the number of feature instances that would be returned.
    
    Parameters:
    resultType - the value of field 'resultType'.
  - setTraverseXlinkDepth
```
public void setTraverseXlinkDepth(String traverseXlinkDepth)
```
    Sets the value of field 'traverseXlinkDepth'. The field 'traverseXlinkDepth' has the following description: This attribute indicates the depth to which nested property XLink linking element locator attribute (href) XLinks are traversed and resolved if possible. A value of "1" indicates that one linking element locator attribute (href) Xlink will be traversed and the referenced element returned if possible, but nested property XLink linking element locator attribute (href) XLinks in the returned element are not traversed. A value of "*" indicates that all nested property XLink linking element locator attribute (href) XLinks will be traversed and the referenced elements returned if possible. The range of valid values for this attribute consists of positive integers plus "*". If this attribute is not specified then no xlinks shall be resolved and the value of traverseXlinkExpiry attribute (if it specified) may be ignored.
    
    Parameters:
    traverseXlinkDepth - the value of field 'traverseXlinkDepth'.
  - setTraverseXlinkExpiry
```
public void setTraverseXlinkExpiry(int traverseXlinkExpiry)
```
    Sets the value of field 'traverseXlinkExpiry'. The field 'traverseXlinkExpiry' has the following description: The traverseXlinkExpiry attribute value is specified in minutes. It indicates how long a Web Feature Service should wait to receive a response to a nested GetGmlObject request. This attribute is only relevant if a value is specified for the traverseXlinkDepth attribute.
    
    Parameters:
    traverseXlinkExpiry - the value of field 'traverseXlinkExpiry'.
  - unmarshal
```
public static BaseRequestType unmarshal(Reader reader)
                                 throws org.exolab.castor.xml.MarshalException,
                                        org.exolab.castor.xml.ValidationException
```
    Method unmarshal
    
    Parameters:
    reader -
    
    Returns:
    BaseRequestType
    
    Throws:
    
    org.exolab.castor.xml.MarshalException
    
    org.exolab.castor.xml.ValidationException
  - validate
```
public void validate()
              throws org.exolab.castor.xml.ValidationException
```
    Method validate
    
    Overrides:
    
    validate in class BaseRequestType
    
    Throws:
    
    org.exolab.castor.xml.ValidationException

Class GetFeatureType

Constructor Summary

Method Summary

Methods inherited from class nl.b3p.ogc.wfs.v110.BaseRequestType

Methods inherited from class java.lang.Object

Constructor Detail

GetFeatureType

Method Detail

addQuery

addQuery

clearQuery

deleteMaxFeatures

deleteTraverseXlinkExpiry

enumerateQuery

getMaxFeatures

getOutputFormat

getQuery

getQuery

getQueryCount

getResultType

getTraverseXlinkDepth

getTraverseXlinkExpiry

hasMaxFeatures

hasTraverseXlinkExpiry

isValid

marshal

marshal

removeQuery

setMaxFeatures

setOutputFormat

setQuery

setQuery

setResultType

setTraverseXlinkDepth

setTraverseXlinkExpiry

unmarshal

validate