net.opengis.wfs
Interface QueryType

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Implementing Classes:
QueryTypeImpl

public interface QueryType
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'Query Type'. The Query element is of type QueryType.

The following features are supported:

See Also:
WfsPackage.getQueryType()

Method Summary
 java.lang.String getFeatureVersion()
          Returns the value of the 'Feature Version' attribute.
 org.opengis.filter.Filter getFilter()
          Returns the value of the 'Filter' attribute.
 org.eclipse.emf.common.util.EList getFunction()
          Returns the value of the 'Function' attribute list.
 org.eclipse.emf.ecore.util.FeatureMap getGroup()
          Returns the value of the 'Group' attribute list.
 java.lang.String getHandle()
          Returns the value of the 'Handle' attribute.
 org.eclipse.emf.common.util.EList getPropertyName()
          Returns the value of the 'Property Name' attribute.
 org.eclipse.emf.common.util.EList getSortBy()
          Returns the value of the 'Sort By' attribute.
 java.net.URI getSrsName()
          Returns the value of the 'Srs Name' attribute.
 java.util.List getTypeName()
          Returns the value of the 'Type Name' attribute.
 org.eclipse.emf.common.util.EList getXlinkPropertyName()
          Returns the value of the 'Xlink Property Name' containment reference list.
 void setFeatureVersion(java.lang.String value)
          Sets the value of the 'Feature Version' attribute.
 void setFilter(org.opengis.filter.Filter value)
          Sets the value of the 'Filter' attribute.
 void setHandle(java.lang.String value)
          Sets the value of the 'Handle' attribute.
 void setSrsName(java.net.URI value)
          Sets the value of the 'Srs Name' attribute.
 void setTypeName(java.util.List value)
          Sets the value of the 'Type Name' attribute.
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getGroup

org.eclipse.emf.ecore.util.FeatureMap getGroup()
Returns the value of the 'Group' attribute list. The list contents are of type FeatureMap.Entry.

If the meaning of the 'Group' attribute list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Group' attribute list.
See Also:
WfsPackage.getQueryType_Group()

getPropertyName

org.eclipse.emf.common.util.EList getPropertyName()
Returns the value of the 'Property Name' attribute. The Property element 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 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. Of course, using the DescribeFeatureType request, a client application can determine which properties are mandatory and request them in the first place.

Returns:
the value of the 'Property Name' attribute.
See Also:
#setPropertyName(String), net.opengis.wfs.WFSPackage#getQueryType_PropertyName()

getXlinkPropertyName

org.eclipse.emf.common.util.EList getXlinkPropertyName()
Returns the value of the 'Xlink Property Name' containment reference list. The list contents are of type XlinkPropertyNameType.

If the meaning of the 'Xlink Property Name' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Xlink Property Name' containment reference list.
See Also:
WfsPackage.getQueryType_XlinkPropertyName()

getFunction

org.eclipse.emf.common.util.EList getFunction()
Returns the value of the 'Function' attribute list. The list contents are of type Object. A function may be used as a select item in a query. However, if a function is used, care must be taken to ensure that the result type matches the type in the

Returns:
the value of the 'Function' attribute list.
See Also:
net.opengis.wfs.WFSPackage#getQueryType_Function()

getFilter

org.opengis.filter.Filter getFilter()
Returns the value of the 'Filter' attribute. The Filter element is used to define spatial and/or non-spatial constraints on query. Spatial constrains use GML3 to specify the constraining geometry. A full description of the Filter element can be found in the Filter Encoding Implementation Specification.

Returns:
the value of the 'Filter' attribute.
See Also:
#setFilter(Object), net.opengis.wfs.WFSPackage#getQueryType_Filter()

setFilter

void setFilter(org.opengis.filter.Filter value)
Sets the value of the 'Filter' attribute.

Parameters:
value - the new value of the 'Filter' attribute.
See Also:
getFilter()

getSortBy

org.eclipse.emf.common.util.EList getSortBy()
Returns the value of the 'Sort By' attribute. The SortBy element is used specify property names whose values should be used to order (upon presentation) the set of feature instances that satisfy the query.

Returns:
the value of the 'Sort By' attribute.
See Also:
#setSortBy(Object), net.opengis.wfs.WFSPackage#getQueryType_SortBy()

getFeatureVersion

java.lang.String getFeatureVersion()
Returns the value of the 'Feature Version' attribute. For systems that implement versioning, the featureVersion attribute is used to specify which version of a particular feature instance is to be retrieved. A value of ALL means that all versions should be retrieved. An integer value 'i', means that the ith version should be retrieve if it exists or the most recent version otherwise.

Returns:
the value of the 'Feature Version' attribute.
See Also:
setFeatureVersion(String), WfsPackage.getQueryType_FeatureVersion()

setFeatureVersion

void setFeatureVersion(java.lang.String value)
Sets the value of the 'Feature Version' attribute.

Parameters:
value - the new value of the 'Feature Version' attribute.
See Also:
getFeatureVersion()

getHandle

java.lang.String getHandle()
Returns the value of the 'Handle' attribute. The handle attribute allows a client application to assign a client-generated identifier for the Query. The handle is included to facilitate error reporting. If one Query in a GetFeature request causes an exception, a WFS may report the handle to indicate which query element failed. If the a handle is not present, the WFS may use other means to localize the error (e.g. line numbers).

Returns:
the value of the 'Handle' attribute.
See Also:
setHandle(String), WfsPackage.getQueryType_Handle()

setHandle

void setHandle(java.lang.String value)
Sets the value of the 'Handle' attribute.

Parameters:
value - the new value of the 'Handle' attribute.
See Also:
getHandle()

getSrsName

java.net.URI getSrsName()
Returns the value of the 'Srs Name' attribute. This attribute is used to specify a specific WFS-supported SRS that should be used for returned feature geometries. The value may be the WFS StorageSRS value, DefaultRetrievalSRS value, or one of AdditionalSRS values. If no srsName value is supplied, then the features will be returned using either the DefaultRetrievalSRS, if specified, and StorageSRS otherwise. For feature types with no spatial properties, this attribute must not be specified or ignored if it is specified.

Returns:
the value of the 'Srs Name' attribute.
See Also:
#setSrsName(String), net.opengis.wfs.WFSPackage#getQueryType_SrsName()

setSrsName

void setSrsName(java.net.URI value)
Sets the value of the 'Srs Name' attribute.

Parameters:
value - the new value of the 'Srs Name' attribute.
See Also:
getSrsName()

getTypeName

java.util.List getTypeName()
Returns the value of the 'Type Name' attribute. The typeName attribute is a list of one or more feature type names that indicate which types of feature instances should be included in the reponse set. Specifying more than one typename indicates that a join operation is being performed. All the names in the typeName list must be valid types that belong to this query's feature content as defined by the GML Application Schema.

Returns:
the value of the 'Type Name' attribute.
See Also:
setTypeName(List), WfsPackage.getQueryType_TypeName()

setTypeName

void setTypeName(java.util.List value)
Sets the value of the 'Type Name' attribute.

Parameters:
value - the new value of the 'Type Name' attribute.
See Also:
getTypeName()


Copyright © 1996-2010 Geotools. All Rights Reserved.