org.deegree.protocol.wfs.getfeature
Class BBoxQuery

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

public class BBoxQuery
extends Query

A Query that selects features using an Envelope.

NOTE: Only KVP-based queries can be of this type. For XML-requests its only possible to use a filter constraint.

Version:

$Revision: $, $Date: $

Author:

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

Constructor Summary

BBoxQuery(java.lang.String handle, TypeName[] typeNames, java.lang.String featureVersion, CRS srsName, PropertyName[][] propertyNames, XLinkPropertyName[][] xLinkPropertyNames, SortProperty[] sortBy, Envelope bbox)
Creates a new BBoxQuery instance.

Method Summary

Envelope	getBBox() Returns the bounding box constraint.
PropertyName[][]	getPropertyNames() Returns the properties of the features that should be retrieved.
XLinkPropertyName[][]	getXLinkPropertyNames() Returns the properties of the features for which a specific XLink behaviour is requested.

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

BBoxQuery

public BBoxQuery(java.lang.String handle,
                 TypeName[] typeNames,
                 java.lang.String featureVersion,
                 CRS srsName,
                 PropertyName[][] propertyNames,
                 XLinkPropertyName[][] xLinkPropertyNames,
                 SortProperty[] sortBy,
                 Envelope bbox)

Creates a new BBoxQuery 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

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

bbox - envelope that constraints the query, must not be null

Method Detail

getBBox

public Envelope getBBox()

Returns the bounding box constraint.

Returns:

the bounding box constraint, never null

getPropertyNames

public PropertyName[][] getPropertyNames()

Returns the properties of the features that should be retrieved.

From WFS Speification V1.1, clause 14.7.3.1: A list of properties may be specified for each feature type that is being queried. A "*" character can be used to indicate that all properties should be retrieved. There is a 1:1 mapping between each element in a FEATUREID or TYPENAME list and the PROPERTYNAME list. The absense of a value also indicates that all properties should be fetched.

Returns:

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

getXLinkPropertyNames

public XLinkPropertyName[][] getXLinkPropertyNames()

Returns the properties of the features for which a specific XLink behaviour is requested.

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