|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Deprecated @XmlElement(value="Query") public interface Query
Used by the getFeatures
method
of the data store interface, to encapsulate a request.
A query defines which feature type to query, what properties
to retrieve and what constraints (spatial and non-spatial) to apply to those properties.
It is designed to closesly match a WFS Query element of a getFeatures
request.
A difference is the addition of the maxFeatures
element, which
allows more control over the features selected. It allows a full
getFeatures
request to properly control how many features it gets from each query,
instead of requesting and discarding when the max is reached.
Function
, SortBy
.Method Summary | |
---|---|
CoordinateReferenceSystem |
getCoordinateSystem()
Deprecated. Temporarily override the coordinate reference system. |
CoordinateReferenceSystem |
getCoordinateSystemReproject()
Deprecated. Request data reprojection. |
Filter |
getFilter()
Deprecated. Returns the filter that will limit which features are returned. |
String |
getHandle()
Deprecated. Gives a mnemonic name for use by the client to identify this query. |
int |
getMaxFeatures()
Deprecated. Returns the maximum number of features to be retrieved by the query. |
List<String> |
getPropertyNames()
Deprecated. Returns the list of property names of the features to be retrieved. |
TypeName |
getTypeName()
Deprecated. Returns the name of the type that is to be queried. |
String |
getVersion()
Deprecated. Returns the feature version to query. |
Method Detail |
---|
@XmlElement(value="typeName") TypeName getTypeName()
The provided TypeName is used to look up the correct dataset to be querried.
getTypeNames()
(plural form) in a
future version.@XmlElement(value="Filter") Filter getFilter()
null
if there is none.
@XmlElement(value="Property") List<String> getPropertyNames()
This is used to specify one or more properties of a feature
whose values are to be retrieved by a Web Feature Service. 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 GML 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. Of course, using FeatureAttributeDescriptor
, a client
application can determine which properties are mandatory and request them in the
first place.
@XmlElement(value="handle") String getHandle()
GetFeature
request causes an exception,
a WFS may report the handle to indicate which query element failed. If the
handle is not present, the WFS may use other means to localize the error
(e.g. line numbers).
@Extension int getMaxFeatures()
Integer.MAX_VALUE
to indicate
that the maximum number of features is unlimited.
maxFeatures
is an attribute of getFeature
request.
We may wish to avoid duplication once WMS interfaces are provided in
GeoAPI.@XmlElement(value="featureVersion") String getVersion()
"ALL"
indicates
that all versions of a feature should be fetched. Otherwise an integer, n,
can be specified to return the nth version of a feature. The version numbers start at '1' which is the oldest version. If a version value
larger than the largest version is specified then the latest version is return. The default
action shall be for the query to return the latest version. Systems that do not support
versioning can ignore the parameter and return the only version that they have.
@Extension CoordinateReferenceSystem getCoordinateSystem()
FeatureStore
being queried. The same
coordinate values will be used, but the features created will appear in this CRS.
This change is not persistant at all, indeed it is only for the Feature
s
returned by this Query
. It may be used in conjunction with the reprojection
CRS, but this one will always be used first. The reprojection CRS will perform its
operation on this crs.
Feature
s from this
Query
.FeatureCollection
configuration issue (or a FeatureStore
configuration issue). Recent experience with Geotools shows the added burden
on client code to be a pain., MD: This method is misnamed. CoordinateSystem
and CoordinateReferenceSystem
are not the
same thing.@Extension CoordinateReferenceSystem getCoordinateSystemReproject()
CoordinateSystem
and CoordinateReferenceSystem
are not the
same thing.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |