org.deegree.protocol.wfs.getfeature
Class FilterQuery

java.lang.Object
  org.deegree.protocol.wfs.getfeature.Query
      org.deegree.protocol.wfs.getfeature.FilterQuery

public class FilterQuery
extends Query

A Query that selects features using an optional Filter.

NOTE: XML-based queries are always of this type. Only for KVP requests it is possible to specify a BBOX or a FEATUREID parameter.

Version:

$Revision: $, $Date: $

Author:

Markus Schneider, last edited by: $Author: schneider $

Constructor Summary

FilterQuery(QName typeName, CRS srsName, SortProperty[] sortBy, Filter filter)
Creates a new FilterQuery instance from the most commonly used parameters.

FilterQuery(String handle, TypeName[] typeNames, String featureVersion, CRS srsName, PropertyName[] propertyNames, XLinkPropertyName[] xLinkPropertyNames, Function[] functions, SortProperty[] sortBy, Filter filter)
Creates a new FilterQuery instance.

Method Summary

Filter	getFilter() Returns the filter constraint.
Function[]	getFunctions() Returns the functions that should be fetched instead of the original property values.
PropertyName[]	getPropertyNames() Returns the properties of the features that should be retrieved.
XLinkPropertyName[]	getXLinkPropertyNames() Contains the Depth and Expiry properties for XLinks traversal.

Methods inherited from class org.deegree.protocol.wfs.getfeature.Query

getFeatureVersion, getHandle, getSortBy, getSrsName, getTypeNames

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterQuery

public FilterQuery(String handle,
                   TypeName[] typeNames,
                   String featureVersion,
                   CRS srsName,
                   PropertyName[] propertyNames,
                   XLinkPropertyName[] xLinkPropertyNames,
                   Function[] functions,
                   SortProperty[] sortBy,
                   Filter filter)

Creates a new FilterQuery instance.

Parameters:

handle - client-generated query identifier, may be null

typeNames - requested feature types (with optional aliases), must not be null and must always contain at least one entry

featureVersion - version of the feature instances to be retrieved, may be null

srsName - WFS-supported SRS that should be used for returned feature geometries, may be null

propertyNames - properties of the features that should be retrieved, may be null

xLinkPropertyNames - properties for which the the traversal of nested XLinks is selectively requested, may be null

functions - properties for which a function value should be used instead of the original property value, may be null

sortBy - properties whose values should be used to order the set of feature instances that satisfy the query, may be null

filter - filter constraint, may be null

FilterQuery

public FilterQuery(QName typeName,
                   CRS srsName,
                   SortProperty[] sortBy,
                   Filter filter)

Creates a new FilterQuery instance from the most commonly used parameters.

Parameters:

typeName - requested feature type name, must not be null

srsName - WFS-supported SRS that should be used for returned feature geometries, may be null

sortBy - properties whose values should be used to order the set of feature instances that satisfy the query, may be null

filter - filter constraint, may be null

Method Detail

getFilter

public Filter getFilter()

Returns the filter constraint.

Returns:

the filter constraint, may be null

getPropertyNames

public PropertyName[] getPropertyNames()

Returns the properties of the features that should be retrieved.

From WFS 1.1.0 schema (wfs.xsd): While a Web Feature Service should endeavour to satisfy the exact request specified, in some instance this may not be possible. Specifically, a Web Feature Service must generate a valid GML3 response to a Query operation. The schema used to generate the output may include properties that are mandatory. In order that the output validates, these mandatory properties must be specified in the request. If they are not, a Web Feature Service may add them automatically to the Query before processing it. Thus a client application should, in general, be prepared to receive more properties than it requested.

Returns:

the properties of the features that should be retrieved, may be null

getXLinkPropertyNames

public XLinkPropertyName[] getXLinkPropertyNames()

Contains the Depth and Expiry properties for XLinks traversal. More precisely, the nested depth to which an xlink:href should be traversed (or "*" for indefinite depth), respectively the number of minutes the WFS should wait for a response when traversing through xlinks is encountered.

Returns:

the xLinkPropertyNames. See XLinkPropertyName

getFunctions

public Function[] getFunctions()

Returns the functions that should be fetched instead of the original property values.

Returns:

the functions that should be fetched instead of the original property values, may be null