Package net.opengis.wfs

Interface GetFeatureType

All Superinterfaces:
BaseRequestType, EObject, Notifier
All Known Subinterfaces:
GetFeatureWithLockType
All Known Implementing Classes:
GetFeatureTypeImpl, GetFeatureWithLockTypeImpl
public interface GetFeatureType extends BaseRequestType
A representation of the model object 'Get Feature Type'. A GetFeature element contains one or more Query elements that describe a query operation on one feature type. In response to a GetFeature request, a Web Feature Service must be able to generate a GML3 response that validates using a schema generated by the DescribeFeatureType request. A Web Feature Service may support other possibly non-XML (and even binary) output formats as long as those formats are advertised in the capabilities document.

The following features are supported:

See Also:

  • Method Details

    • getQuery

      EList getQuery()
      Returns the value of the 'Query' containment reference list. The list contents are of type QueryType.

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

      Returns:
      the value of the 'Query' containment reference list.
      See Also:

    • getMaxFeatures

      BigInteger getMaxFeatures()
      Returns the value of the 'Max Features' attribute. The maxFeatures attribute is used to specify the maximum number of features that a GetFeature operation should generate (regardless of the actual number of query hits).
      Returns:
      the value of the 'Max Features' attribute.
      See Also:

    • setMaxFeatures

      void setMaxFeatures(BigInteger value)
      Sets the value of the 'Max Features' attribute.
      Parameters:
      value - the new value of the 'Max Features' attribute.
      See Also:

    • getStartIndex

      BigInteger getStartIndex()
      The initial index of a feature result set in which to return features.

      This property is coupled with getMaxFeatures() to page through a feature result set.

    • setStartIndex

      void setStartIndex(BigInteger value)
      Sets the value of the 'Start Index' attribute.
      Parameters:
      value - the new value of the 'Start Index' attribute.
      See Also:

    • getOutputFormat

      String getOutputFormat()
      Returns the value of the 'Output Format' attribute. The default value is "text/xml; subtype=gml/3.1.1". The outputFormat attribute is used to specify the output format that the Web Feature Service should generate in response to a GetFeature or GetFeatureWithLock element. The default value of 'text/xml; subtype=gml/3.1.1' indicates that the output is an XML document that conforms to the Geography Markup Language (GML) Implementation Specification V3.1.1. For the purposes of experimentation, vendor extension, or even extensions that serve a specific community of interest, other acceptable output format values may be used to specify other formats as long as those values are advertised in the capabilities document. For example, the value WKB may be used to indicate that a Well Known Binary format be used to encode the output.
      Returns:
      the value of the 'Output Format' attribute.
      See Also:

    • setOutputFormat

      void setOutputFormat(String value)
      Sets the value of the 'Output Format' attribute.
      Parameters:
      value - the new value of the 'Output Format' attribute.
      See Also:

    • unsetOutputFormat

      void unsetOutputFormat()
      Unsets the value of the 'Output Format' attribute.
      See Also:

    • isSetOutputFormat

      boolean isSetOutputFormat()
      Returns whether the value of the 'Output Format' attribute is set.
      Returns:
      whether the value of the 'Output Format' attribute is set.
      See Also:

    • getResultType

      ResultTypeType getResultType()
      Returns the value of the 'Result Type' attribute. The default value is "results". The literals are from the enumeration ResultTypeType. The resultType attribute is used to indicate what response a WFS should return to user once a GetFeature request is processed. Possible values are: results - meaning that the full response set (i.e. all the feature instances) should be returned. hits - meaning that an empty response set should be returned (i.e. no feature instances should be returned) but the "numberOfFeatures" attribute should be set to the number of feature instances that would be returned.
      Returns:
      the value of the 'Result Type' attribute.
      See Also:

    • setResultType

      void setResultType(ResultTypeType value)
      Sets the value of the 'Result Type' attribute.
      Parameters:
      value - the new value of the 'Result Type' attribute.
      See Also:

    • unsetResultType

      void unsetResultType()
      Unsets the value of the 'Result Type' attribute.
      See Also:

    • isSetResultType

      boolean isSetResultType()
      Returns whether the value of the 'Result Type' attribute is set.
      Returns:
      whether the value of the 'Result Type' attribute is set.
      See Also:

    • getTraverseXlinkDepth

      String getTraverseXlinkDepth()
      Returns the value of the 'Traverse Xlink Depth' attribute. This attribute indicates the depth to which nested property XLink linking element locator attribute (href) XLinks 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 " ". If this attribute is not specified then no xlinks shall be resolved and the value of traverseXlinkExpiry attribute (if it specified) may be ignored.
      Returns:
      the value of the 'Traverse Xlink Depth' attribute.
      See Also:

    • setTraverseXlinkDepth

      void setTraverseXlinkDepth(String value)
      Sets the value of the 'Traverse Xlink Depth' attribute.
      Parameters:
      value - the new value of the 'Traverse Xlink Depth' attribute.
      See Also:

    • getTraverseXlinkExpiry

      BigInteger getTraverseXlinkExpiry()
      Returns the value of the 'Traverse Xlink Expiry' attribute. The traverseXlinkExpiry attribute value is specified in minutes. It indicates how long a Web Feature Service should wait to receive a response to a nested GetGmlObject request. This attribute is only relevant if a value is specified for the traverseXlinkDepth attribute.
      Returns:
      the value of the 'Traverse Xlink Expiry' attribute.
      See Also:

    • setTraverseXlinkExpiry

      void setTraverseXlinkExpiry(BigInteger value)
      Sets the value of the 'Traverse Xlink Expiry' attribute.
      Parameters:
      value - the new value of the 'Traverse Xlink Expiry' attribute.
      See Also:

    • getFormatOptions

      Map getFormatOptions()
      The format options to be applied to any response to the GetFeature requst.

      This property is not part of the standard model but an extension.

    • setFormatOptions

      void setFormatOptions(Map value)
      Sets the value of the 'Format Options' attribute.
      Parameters:
      value - the new value of the 'Format Options' attribute.
      See Also:

    • getMetadata

      Map getMetadata()
      A generic bag of extra information that implementations can use to carry vendor parameters

      This property is not part of the standard model but an extension.

    • setMetadata

      void setMetadata(Map value)
      Sets the value of the 'Metadata' attribute.
      Parameters:
      value - the new value of the 'Metadata' attribute.
      See Also:

    • getViewParams

      EList getViewParams()
      A list of maps containing "View Parameters" to be plugged into the request

      This property is not part of the standard model but an extension.