org.deegree.services.wfs.protocol
Interface WFSGetFeatureRequest

All Superinterfaces:

OGCWebServiceRequest, WFSBasicRequest

All Known Subinterfaces:

WFSGetFeatureWithLockRequest, WFSGGetFeatureRequest

All Known Implementing Classes:

WFSGetFeatureRequest_Impl, WFSGetFeatureWithLockRequest_Impl, WFSGGetFeatureRequest_Impl

public interface WFSGetFeatureRequest

extends WFSBasicRequest

The GetFeature interface can be used to package one or more query descriptions into a single request. The results of all queries packaged in a GetFeature request are concatenated to produce the result set.

--------------------------------------------------------

Version:

$Revision: 1.3 $ $Date: 2004/02/09 07:57:02 $

Author:

Andreas Poth

Method Summary

java.lang.String[]	getFeatureIds() A list of feature identifiers upon which the specified operation shall be applied.
Filter	getFilter() A filter specification describes a set of features to operate upon.
java.lang.String	getHandle() The handle attribute is included to allow a client to associate a mnemonic name to the request.
int	getMaxFeatures() The optional maxFeatures attribute can be used to limit the number of features that a GetFeature request retrieves.
java.lang.String	getOutputFormat() The outputFormat attribute defines the format to use to generate the result set.
java.lang.String[]	getPropertyNames() The property names is used to enumerate the feature properties or attributes that should be selected.
WFSQuery[]	getQuery() The query defines which feature type to query, what properties to retrieve and what constraints (spatial and non-spatial) to apply to those properties.
int	getStartPosition() The startPosition parameter identifies the first result set entry to be returned specified the default is the first record
java.lang.String[]	getTypeNames() A list of feature type names to query.

Methods inherited from interface org.deegree.services.wfs.protocol.WFSBasicRequest

getNative

Methods inherited from interface org.deegree.services.OGCWebServiceRequest

getId, getRequest, getRequestParameter, getService, getVendorSpecificParameter, getVendorSpecificParameters, getVersion

Method Detail

getOutputFormat

public java.lang.String getOutputFormat()

The outputFormat attribute defines the format to use to generate the result set. Vendor specific formats, declared in the capabilities document are possible. The WFS-specs implies GML as default output format.

getHandle

public java.lang.String getHandle()

The handle attribute is included to allow a client to associate a mnemonic name to the request. The purpose of the handle attribute is to provide an error handling mechanism for locating a statement that might fail.

getQuery

public WFSQuery[] getQuery()

The query defines which feature type to query, what properties to retrieve and what constraints (spatial and non-spatial) to apply to those properties.

only used for xml-coded requests

getMaxFeatures

public int getMaxFeatures()

The optional maxFeatures attribute can be used to limit the number of features that a GetFeature request retrieves. Once the maxFeatures limit is reached, the result set is truncated at that point.

getStartPosition

public int getStartPosition()

The startPosition parameter identifies the first result set entry to be returned specified the default is the first record

getPropertyNames

public java.lang.String[] getPropertyNames()

The property names is used to enumerate the feature properties or attributes that should be selected. If no property names are specified then all properties should be fetched.

only use for name-value-pair encoded requests

getFeatureIds

public java.lang.String[] getFeatureIds()

A list of feature identifiers upon which the specified operation shall be applied. Optional. No default.

Only used for name-value-pair encoded requests

getTypeNames

public java.lang.String[] getTypeNames()

A list of feature type names to query. Optional. No default.

only used for name-value-pair encoded requests

getFilter

public Filter getFilter()

A filter specification describes a set of features to operate upon. The format of the filter is defined in the OGC Filter Encoding Specification. Optional. No default. Prerequisite: TYPENAME