| org.deegree.ogcwebservices.wfs.operation.AbstractWFSRequest
 org.deegree.ogcwebservices.wfs.operation.GetFeature
All known Subclasses: org.deegree.ogcwebservices.wfs.operation.AugmentableGetFeature, org.deegree.ogcwebservices.wfs.operation.GetFeatureWithLock,
| GetFeature | | public class GetFeature extends AbstractWFSRequest (Code) | | Represents a GetFeature request to a web feature service.
The GetFeature operation allows the retrieval of features from a web feature service. A GetFeature request is
processed by a WFS and when the value of the outputFormat attribute is set to text/gml; subtype=gml/3.1.1, a GML
instance document, containing the result set, is returned to the client.
author:
Andreas Poth
author:
Markus Schneider
author:
last edited by: $Author: mschneider $
version:
$Revision: 9534 $, $Date: 2008-01-14 09:37:41 -0800 (Mon, 14 Jan 2008) $ |
| Inner Class :public static enum RESULT_TYPE | |
| Constructor Summary | |
| | GetFeature(String version, String id, String handle, RESULT_TYPE resultType, String outputFormat, int maxFeatures, int startPosition, int traverseXLinkDepth, int traverseXLinkExpiry, Query[] queries, Map<String, String> vendorSpecificParam)
Creates a new GetFeature instance. | | protected | GetFeature()
|
| Method Summary | |
| public static GetFeature | create(String version, String id, RESULT_TYPE resultType, String outputFormat, String handle, int maxFeatures, int startPosition, int traverseXLinkDepth, int traverseXLinkExpiry, Query[] queries)
Creates a new GetFeature instance from the given parameters. | | public static GetFeature | create(String id, Element root)
Creates a new GetFeature instance from a document that contains the DOM representation of the
request. | | public static GetFeature | create(String id, String request)
Creates a new GetFeature instance from the given key-value pair encoded request. | | public static GetFeature | create(Map<String, String> kvp)
Creates a new GetFeature request from the given map. | | protected static Map<QualifiedName, PropertyPath[]> | extractPropNames(Map<String, String> kvp, QualifiedName[] typeNames)
Extracts the PROPERTYNAME parameter and assigns them to the requested type names. | | public int | getMaxFeatures()
The optional maxFeatures attribute can be used to limit the number of features that a GetFeature request
retrieves. | | public String | getOutputFormat()
Returns the output format.
The outputFormat attribute defines the format to use to generate the result set. | | public Query[] | 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. | | public RESULT_TYPE | getResultType()
Returns the desired result type of the GetFeature operation. | | public int | getStartPosition()
The startPosition parameter identifies the first result set entry to be returned specified the default is the
first record. | | public int | getTraverseXLinkDepth()
The optional traverseXLinkDepth attribute indicates the depth to which nested property XLink linking element
locator attribute (href) XLinks in all properties of the selected feature(s) are traversed and resolved if
possible. | | public int | getTraverseXLinkExpiry()
The traverseXLinkExpiry attribute is specified in minutes. | | public void | setMaxFeatures(int max)
| | public void | setQueries(Query[] query)
| | public String | toString()
|
| FORMAT_FEATURECOLLECTION | | final public static String FORMAT_FEATURECOLLECTION(Code) | | Serialized java object format (deegree specific extension) *
|
| maxFeatures | | protected int maxFeatures(Code) | | |
| resultType | | protected RESULT_TYPE resultType(Code) | | |
| startPosition | | protected int startPosition(Code) | | |
| GetFeature | | GetFeature(String version, String id, String handle, RESULT_TYPE resultType, String outputFormat, int maxFeatures, int startPosition, int traverseXLinkDepth, int traverseXLinkExpiry, Query[] queries, Map<String, String> vendorSpecificParam)(Code) | | Creates a new GetFeature instance.
Parameters:
version - request version
Parameters:
id - id of the request
Parameters:
handle -
Parameters:
resultType - desired result type (results | hits)
Parameters:
outputFormat - requested result format
Parameters:
maxFeatures -
Parameters:
startPosition - deegree specific parameter defining where to start considering features
Parameters:
traverseXLinkDepth -
Parameters:
traverseXLinkExpiry -
Parameters:
queries -
Parameters:
vendorSpecificParam - |
| GetFeature | | protected GetFeature()(Code) | | |
| create | | public static GetFeature create(String version, String id, RESULT_TYPE resultType, String outputFormat, String handle, int maxFeatures, int startPosition, int traverseXLinkDepth, int traverseXLinkExpiry, Query[] queries)(Code) | | Creates a new GetFeature instance from the given parameters.
Parameters:
version - request version
Parameters:
id - id of the request
Parameters:
resultType - desired result type (results | hits)
Parameters:
outputFormat - requested result format
Parameters:
handle -
Parameters:
maxFeatures - default = -1 (all features)
Parameters:
startPosition - default = 0 (starting at the first feature)
Parameters:
traverseXLinkDepth -
Parameters:
traverseXLinkExpiry -
Parameters:
queries - a set of Query objects that describes the query to perform new GetFeature request |
| create | | public static GetFeature create(String id, Element root) throws OGCWebServiceException(Code) | | Creates a new GetFeature instance from a document that contains the DOM representation of the
request.
Parameters:
id - of the request
Parameters:
root - element that contains the DOM representation of the request new GetFeature request
throws:
OGCWebServiceException - |
| getMaxFeatures | | public int getMaxFeatures()(Code) | | 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. If not limit is set
-1 will be returned.
number of feature to fetch, -1 if no limit is set |
| getOutputFormat | | public String getOutputFormat()(Code) | | Returns the output format.
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.
the output format. |
| getQuery | | public Query[] getQuery()(Code) | | 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
contained queries |
| getResultType | | public RESULT_TYPE getResultType()(Code) | | Returns the desired result type of the GetFeature operation. Possible values are 'results' and 'hits'.
the desired result type |
| getStartPosition | | public int getStartPosition()(Code) | | The startPosition parameter identifies the first result set entry to be returned specified the default is the
first record. If not startposition is set 0 will be returned
the first result set entry to be returned |
| getTraverseXLinkDepth | | public int getTraverseXLinkDepth()(Code) | | The optional traverseXLinkDepth attribute indicates the depth to which nested property XLink linking element
locator attribute (href) XLinks in all properties of the selected feature(s) 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 "*".
the depth to which nested property XLinks are traversed and resolved |
| getTraverseXLinkExpiry | | public int getTraverseXLinkExpiry()(Code) | | The traverseXLinkExpiry attribute is specified in minutes. It indicates how long a Web Feature Service should
wait to receive a response to a nested GetGmlObject request. If no traverseXLinkExpiry attribute is present for a
GetGmlObject request, the WFS wait time is implementation dependent.
how long to wait to receive a response to a nested GetGmlObject request |
| setQueries | | public void setQueries(Query[] query)(Code) | | sets the
Parameters:
query - |
|
|