QueryType (b3p-commons-gis 8.0 API)

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Query
```
public class QueryType
extends Object
implements Serializable
```
The Query element is of type QueryType.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

QueryType()

Constructors
Constructor and Description
`QueryType()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addQueryTypeChoice(int index, QueryTypeChoice vQueryTypeChoice)` Method addQueryTypeChoice
`void`	`addQueryTypeChoice(QueryTypeChoice vQueryTypeChoice)` Method addQueryTypeChoice
`void`	`clearQueryTypeChoice()` Method clearQueryTypeChoice
`Enumeration`	`enumerateQueryTypeChoice()` Method enumerateQueryTypeChoice
`String`	`getFeatureVersion()` Returns the value of field 'featureVersion'.
`Filter`	`getFilter()` Returns the value of field 'filter'.
`String`	`getHandle()` Returns the value of field 'handle'.
`QueryTypeChoice[]`	`getQueryTypeChoice()` Method getQueryTypeChoice
`QueryTypeChoice`	`getQueryTypeChoice(int index)` Method getQueryTypeChoice
`int`	`getQueryTypeChoiceCount()` Method getQueryTypeChoiceCount
`SortBy`	`getSortBy()` Returns the value of field 'sortBy'.
`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`	`removeQueryTypeChoice(QueryTypeChoice vQueryTypeChoice)` Method removeQueryTypeChoice
`void`	`setFeatureVersion(String featureVersion)` Sets the value of field 'featureVersion'.
`void`	`setFilter(Filter filter)` Sets the value of field 'filter'.
`void`	`setHandle(String handle)` Sets the value of field 'handle'.
`void`	`setQueryTypeChoice(int index, QueryTypeChoice vQueryTypeChoice)` Method setQueryTypeChoice
`void`	`setQueryTypeChoice(QueryTypeChoice[] queryTypeChoiceArray)` Method setQueryTypeChoice
`void`	`setSortBy(SortBy sortBy)` Sets the value of field 'sortBy'.
`void`	`setSrsName(String srsName)` Sets the value of field 'srsName'.
`void`	`setTypeName(String typeName)` Sets the value of field 'typeName'.
`static QueryType`	`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
  - QueryType
```
public QueryType()
```
- Method Detail
  - addQueryTypeChoice
```
public void addQueryTypeChoice(QueryTypeChoice vQueryTypeChoice)
                        throws IndexOutOfBoundsException
```
    Method addQueryTypeChoice
    
    Parameters:
    
    vQueryTypeChoice -
    
    Throws:
    
    IndexOutOfBoundsException
  - addQueryTypeChoice
```
public void addQueryTypeChoice(int index,
                               QueryTypeChoice vQueryTypeChoice)
                        throws IndexOutOfBoundsException
```
    Method addQueryTypeChoice
    
    Parameters:
    
    index -
    
    vQueryTypeChoice -
    
    Throws:
    
    IndexOutOfBoundsException
  - clearQueryTypeChoice
```
public void clearQueryTypeChoice()
```
    Method clearQueryTypeChoice
  - enumerateQueryTypeChoice
```
public Enumeration enumerateQueryTypeChoice()
```
    Method enumerateQueryTypeChoice
    
    Returns:
    
    Enumeration
  - getFeatureVersion
```
public String getFeatureVersion()
```
    Returns the value of field 'featureVersion'. The field 'featureVersion' has the following description: For systems that implement versioning, the featureVersion attribute is used to specify which version of a particular feature instance is to be retrieved. A value of ALL means that all versions should be retrieved. An integer value 'i', means that the ith version should be retrieve if it exists or the most recent version otherwise.
    
    Returns:
    
    String
  - getFilter
```
public Filter getFilter()
```
    Returns the value of field 'filter'. The field 'filter' has the following description: The Filter element is used to define spatial and/or non-spatial constraints on query. Spatial constrains use GML3 to specify the constraining geometry. A full description of the Filter element can be found in the Filter Encoding Implementation Specification.
    
    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 identifier for the Query. The handle is included to facilitate error reporting. If one Query in a GetFeature request causes an exception, a WFS may report the handle to indicate which query element failed. If the a handle is not present, the WFS may use other means to localize the error (e.g. line numbers).
    
    Returns:
    
    String
  - getQueryTypeChoice
```
public QueryTypeChoice getQueryTypeChoice(int index)
                                   throws IndexOutOfBoundsException
```
    Method getQueryTypeChoice
    
    Parameters:
    
    index -
    
    Returns:
    
    QueryTypeChoice
    
    Throws:
    
    IndexOutOfBoundsException
  - getQueryTypeChoice
```
public QueryTypeChoice[] getQueryTypeChoice()
```
    Method getQueryTypeChoice
    
    Returns:
    
    QueryTypeChoice
  - getQueryTypeChoiceCount
```
public int getQueryTypeChoiceCount()
```
    Method getQueryTypeChoiceCount
    
    Returns:
    
    int
  - getSortBy
```
public SortBy getSortBy()
```
    Returns the value of field 'sortBy'. The field 'sortBy' has the following description: The SortBy element is used specify property names whose values should be used to order (upon presentation) the set of feature instances that satisfy the query.
    
    Returns:
    
    SortBy
  - getSrsName
```
public String getSrsName()
```
    Returns the value of field 'srsName'. The field 'srsName' has the following description: This attribute is used to specify a specific WFS-supported SRS that should be used for returned feature geometries. The value may be the WFS StorageSRS value, DefaultRetrievalSRS value, or one of AdditionalSRS values. If no srsName value is supplied, then the features will be returned using either the DefaultRetrievalSRS, if specified, and StorageSRS otherwise. For feature types with no spatial properties, this attribute must not be specified or ignored if it is specified.
    
    Returns:
    
    String
  - getTypeName
```
public String getTypeName()
```
    Returns the value of field 'typeName'. The field 'typeName' has the following description: The typeName attribute is a list of one or more feature type names that indicate which types of feature instances should be included in the reponse set. Specifying more than one typename indicates that a join operation is being performed. All the names in the typeName list must be valid types that belong to this query's 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
  - removeQueryTypeChoice
```
public boolean removeQueryTypeChoice(QueryTypeChoice vQueryTypeChoice)
```
    Method removeQueryTypeChoice
    
    Parameters:
    
    vQueryTypeChoice -
    
    Returns:
    
    boolean
  - setFeatureVersion
```
public void setFeatureVersion(String featureVersion)
```
    Sets the value of field 'featureVersion'. The field 'featureVersion' has the following description: For systems that implement versioning, the featureVersion attribute is used to specify which version of a particular feature instance is to be retrieved. A value of ALL means that all versions should be retrieved. An integer value 'i', means that the ith version should be retrieve if it exists or the most recent version otherwise.
    
    Parameters:
    
    featureVersion - the value of field 'featureVersion'.
  - 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 define spatial and/or non-spatial constraints on query. Spatial constrains use GML3 to specify the constraining geometry. A full description of the Filter element can be found in the Filter Encoding Implementation Specification.
    
    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 identifier for the Query. The handle is included to facilitate error reporting. If one Query in a GetFeature request causes an exception, a WFS may report the handle to indicate which query element failed. If the a handle is not present, the WFS may use other means to localize the error (e.g. line numbers).
    
    Parameters:
    
    handle - the value of field 'handle'.
  - setQueryTypeChoice
```
public void setQueryTypeChoice(int index,
                               QueryTypeChoice vQueryTypeChoice)
                        throws IndexOutOfBoundsException
```
    Method setQueryTypeChoice
    
    Parameters:
    
    index -
    
    vQueryTypeChoice -
    
    Throws:
    
    IndexOutOfBoundsException
  - setQueryTypeChoice
```
public void setQueryTypeChoice(QueryTypeChoice[] queryTypeChoiceArray)
```
    Method setQueryTypeChoice
    
    Parameters:
    
    queryTypeChoiceArray -
  - setSortBy
```
public void setSortBy(SortBy sortBy)
```
    Sets the value of field 'sortBy'. The field 'sortBy' has the following description: The SortBy element is used specify property names whose values should be used to order (upon presentation) the set of feature instances that satisfy the query.
    
    Parameters:
    
    sortBy - the value of field 'sortBy'.
  - setSrsName
```
public void setSrsName(String srsName)
```
    Sets the value of field 'srsName'. The field 'srsName' has the following description: This attribute is used to specify a specific WFS-supported SRS that should be used for returned feature geometries. The value may be the WFS StorageSRS value, DefaultRetrievalSRS value, or one of AdditionalSRS values. If no srsName value is supplied, then the features will be returned using either the DefaultRetrievalSRS, if specified, and StorageSRS otherwise. For feature types with no spatial properties, this attribute must not be specified or ignored if it is specified.
    
    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 typeName attribute is a list of one or more feature type names that indicate which types of feature instances should be included in the reponse set. Specifying more than one typename indicates that a join operation is being performed. All the names in the typeName list must be valid types that belong to this query's feature content as defined by the GML Application Schema.
    
    Parameters:
    
    typeName - the value of field 'typeName'.
  - unmarshal
```
public static QueryType unmarshal(Reader reader)
                           throws org.exolab.castor.xml.MarshalException,
                                  org.exolab.castor.xml.ValidationException
```
    Method unmarshal
    
    Parameters:
    
    reader -
    
    Returns:
    
    QueryType
    
    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 QueryType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QueryType

Method Detail

addQueryTypeChoice

addQueryTypeChoice

clearQueryTypeChoice

enumerateQueryTypeChoice

getFeatureVersion

getFilter

getHandle

getQueryTypeChoice

getQueryTypeChoice

getQueryTypeChoiceCount

getSortBy

getSrsName

getTypeName

isValid

marshal

marshal

removeQueryTypeChoice

setFeatureVersion

setFilter

setHandle

setQueryTypeChoice

setQueryTypeChoice

setSortBy

setSrsName

setTypeName

unmarshal

validate