001: /**
002: * <copyright>
003: * </copyright>
004: *
005: * $Id: GetFeatureType.java 7522 2007-09-12 22:00:10Z saul.farber $
006: */package net.opengis.wfs;
007:
008: import java.math.BigInteger;
009:
010: import org.eclipse.emf.common.util.EList;
011:
012: /**
013: * <!-- begin-user-doc -->
014: * A representation of the model object '<em><b>Get Feature Type</b></em>'.
015: * <!-- end-user-doc -->
016: *
017: * <!-- begin-model-doc -->
018: *
019: * A GetFeature element contains one or more Query elements
020: * that describe a query operation on one feature type. In
021: * response to a GetFeature request, a Web Feature Service
022: * must be able to generate a GML3 response that validates
023: * using a schema generated by the DescribeFeatureType request.
024: * A Web Feature Service may support other possibly non-XML
025: * (and even binary) output formats as long as those formats
026: * are advertised in the capabilities document.
027: * <!-- end-model-doc -->
028: *
029: * <p>
030: * The following features are supported:
031: * <ul>
032: * <li>{@link net.opengis.wfs.GetFeatureType#getQuery <em>Query</em>}</li>
033: * <li>{@link net.opengis.wfs.GetFeatureType#getMaxFeatures <em>Max Features</em>}</li>
034: * <li>{@link net.opengis.wfs.GetFeatureType#getOutputFormat <em>Output Format</em>}</li>
035: * <li>{@link net.opengis.wfs.GetFeatureType#getResultType <em>Result Type</em>}</li>
036: * <li>{@link net.opengis.wfs.GetFeatureType#getTraverseXlinkDepth <em>Traverse Xlink Depth</em>}</li>
037: * <li>{@link net.opengis.wfs.GetFeatureType#getTraverseXlinkExpiry <em>Traverse Xlink Expiry</em>}</li>
038: * </ul>
039: * </p>
040: *
041: * @see net.opengis.wfs.WfsPackage#getGetFeatureType()
042: * @model extendedMetaData="name='GetFeatureType' kind='elementOnly'"
043: * @generated
044: */
045: public interface GetFeatureType extends BaseRequestType {
046: /**
047: * Returns the value of the '<em><b>Query</b></em>' containment reference list.
048: * The list contents are of type {@link net.opengis.wfs.QueryType}.
049: * <!-- begin-user-doc -->
050: * <p>
051: * If the meaning of the '<em>Query</em>' containment reference list isn't clear,
052: * there really should be more of a description here...
053: * </p>
054: * <!-- end-user-doc -->
055: * @return the value of the '<em>Query</em>' containment reference list.
056: * @see net.opengis.wfs.WfsPackage#getGetFeatureType_Query()
057: * @model type="net.opengis.wfs.QueryType" containment="true" required="true"
058: * extendedMetaData="kind='element' name='Query' namespace='##targetNamespace'"
059: * @generated
060: */
061: EList getQuery();
062:
063: /**
064: * Returns the value of the '<em><b>Max Features</b></em>' attribute.
065: * <!-- begin-user-doc -->
066: * <!-- end-user-doc -->
067: * <!-- begin-model-doc -->
068: *
069: * The maxFeatures attribute is used to specify the maximum
070: * number of features that a GetFeature operation should
071: * generate (regardless of the actual number of query hits).
072: * <!-- end-model-doc -->
073: * @return the value of the '<em>Max Features</em>' attribute.
074: * @see #setMaxFeatures(BigInteger)
075: * @see net.opengis.wfs.WfsPackage#getGetFeatureType_MaxFeatures()
076: * @model unique="false" dataType="org.eclipse.emf.ecore.xml.type.PositiveInteger"
077: * extendedMetaData="kind='attribute' name='maxFeatures'"
078: * @generated
079: */
080: BigInteger getMaxFeatures();
081:
082: /**
083: * Sets the value of the '{@link net.opengis.wfs.GetFeatureType#getMaxFeatures <em>Max Features</em>}' attribute.
084: * <!-- begin-user-doc -->
085: * <!-- end-user-doc -->
086: * @param value the new value of the '<em>Max Features</em>' attribute.
087: * @see #getMaxFeatures()
088: * @generated
089: */
090: void setMaxFeatures(BigInteger value);
091:
092: /**
093: * Returns the value of the '<em><b>Output Format</b></em>' attribute.
094: * The default value is <code>"text/xml; subtype=gml/3.1.1"</code>.
095: * <!-- begin-user-doc -->
096: * <!-- end-user-doc -->
097: * <!-- begin-model-doc -->
098: *
099: * The outputFormat attribute is used to specify the output
100: * format that the Web Feature Service should generate in
101: * response to a GetFeature or GetFeatureWithLock element.
102: * The default value of 'text/xml; subtype=gml/3.1.1'
103: * indicates that the output is an XML document that
104: * conforms to the Geography Markup Language (GML)
105: * Implementation Specification V3.1.1.
106: * For the purposes of experimentation, vendor extension,
107: * or even extensions that serve a specific community of
108: * interest, other acceptable output format values may be
109: * used to specify other formats as long as those values
110: * are advertised in the capabilities document.
111: * For example, the value WKB may be used to indicate that a
112: * Well Known Binary format be used to encode the output.
113: * <!-- end-model-doc -->
114: * @return the value of the '<em>Output Format</em>' attribute.
115: * @see #isSetOutputFormat()
116: * @see #unsetOutputFormat()
117: * @see #setOutputFormat(String)
118: * @see net.opengis.wfs.WfsPackage#getGetFeatureType_OutputFormat()
119: * @model default="text/xml; subtype=gml/3.1.1" unique="false" unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.String"
120: * extendedMetaData="kind='attribute' name='outputFormat'"
121: * @generated
122: */
123: String getOutputFormat();
124:
125: /**
126: * Sets the value of the '{@link net.opengis.wfs.GetFeatureType#getOutputFormat <em>Output Format</em>}' attribute.
127: * <!-- begin-user-doc -->
128: * <!-- end-user-doc -->
129: * @param value the new value of the '<em>Output Format</em>' attribute.
130: * @see #isSetOutputFormat()
131: * @see #unsetOutputFormat()
132: * @see #getOutputFormat()
133: * @generated
134: */
135: void setOutputFormat(String value);
136:
137: /**
138: * Unsets the value of the '{@link net.opengis.wfs.GetFeatureType#getOutputFormat <em>Output Format</em>}' attribute.
139: * <!-- begin-user-doc -->
140: * <!-- end-user-doc -->
141: * @see #isSetOutputFormat()
142: * @see #getOutputFormat()
143: * @see #setOutputFormat(String)
144: * @generated
145: */
146: void unsetOutputFormat();
147:
148: /**
149: * Returns whether the value of the '{@link net.opengis.wfs.GetFeatureType#getOutputFormat <em>Output Format</em>}' attribute is set.
150: * <!-- begin-user-doc -->
151: * <!-- end-user-doc -->
152: * @return whether the value of the '<em>Output Format</em>' attribute is set.
153: * @see #unsetOutputFormat()
154: * @see #getOutputFormat()
155: * @see #setOutputFormat(String)
156: * @generated
157: */
158: boolean isSetOutputFormat();
159:
160: /**
161: * Returns the value of the '<em><b>Result Type</b></em>' attribute.
162: * The default value is <code>"results"</code>.
163: * The literals are from the enumeration {@link net.opengis.wfs.ResultTypeType}.
164: * <!-- begin-user-doc -->
165: * <!-- end-user-doc -->
166: * <!-- begin-model-doc -->
167: *
168: * The resultType attribute is used to indicate
169: * what response a WFS should return to user once
170: * a GetFeature request is processed.
171: * Possible values are:
172: * results - meaning that the full response set
173: * (i.e. all the feature instances)
174: * should be returned.
175: * hits - meaning that an empty response set
176: * should be returned (i.e. no feature
177: * instances should be returned) but
178: * the "numberOfFeatures" attribute
179: * should be set to the number of feature
180: * instances that would be returned.
181: * <!-- end-model-doc -->
182: * @return the value of the '<em>Result Type</em>' attribute.
183: * @see net.opengis.wfs.ResultTypeType
184: * @see #isSetResultType()
185: * @see #unsetResultType()
186: * @see #setResultType(ResultTypeType)
187: * @see net.opengis.wfs.WfsPackage#getGetFeatureType_ResultType()
188: * @model default="results" unique="false" unsettable="true"
189: * extendedMetaData="kind='attribute' name='resultType'"
190: * @generated
191: */
192: ResultTypeType getResultType();
193:
194: /**
195: * Sets the value of the '{@link net.opengis.wfs.GetFeatureType#getResultType <em>Result Type</em>}' attribute.
196: * <!-- begin-user-doc -->
197: * <!-- end-user-doc -->
198: * @param value the new value of the '<em>Result Type</em>' attribute.
199: * @see net.opengis.wfs.ResultTypeType
200: * @see #isSetResultType()
201: * @see #unsetResultType()
202: * @see #getResultType()
203: * @generated
204: */
205: void setResultType(ResultTypeType value);
206:
207: /**
208: * Unsets the value of the '{@link net.opengis.wfs.GetFeatureType#getResultType <em>Result Type</em>}' attribute.
209: * <!-- begin-user-doc -->
210: * <!-- end-user-doc -->
211: * @see #isSetResultType()
212: * @see #getResultType()
213: * @see #setResultType(ResultTypeType)
214: * @generated
215: */
216: void unsetResultType();
217:
218: /**
219: * Returns whether the value of the '{@link net.opengis.wfs.GetFeatureType#getResultType <em>Result Type</em>}' attribute is set.
220: * <!-- begin-user-doc -->
221: * <!-- end-user-doc -->
222: * @return whether the value of the '<em>Result Type</em>' attribute is set.
223: * @see #unsetResultType()
224: * @see #getResultType()
225: * @see #setResultType(ResultTypeType)
226: * @generated
227: */
228: boolean isSetResultType();
229:
230: /**
231: * Returns the value of the '<em><b>Traverse Xlink Depth</b></em>' attribute.
232: * <!-- begin-user-doc -->
233: * <!-- end-user-doc -->
234: * <!-- begin-model-doc -->
235: *
236: * This attribute indicates the depth to which nested property
237: * XLink linking element locator attribute (href) XLinks are
238: * traversed and resolved if possible. A value of "1"
239: * indicates that one linking element locator attribute
240: * (href) Xlink will be traversed and the referenced element
241: * returned if possible, but nested property XLink linking
242: * element locator attribute (href) XLinks in the returned
243: * element are not traversed. A value of "
244: * " indicates that
245: * all nested property XLink linking element locator attribute
246: * (href) XLinks will be traversed and the referenced elements
247: * returned if possible. The range of valid values for this
248: * attribute consists of positive integers plus "
249: * ".
250: * If this attribute is not specified then no xlinks shall be
251: * resolved and the value of traverseXlinkExpiry attribute (if
252: * it specified) may be ignored.
253: * <!-- end-model-doc -->
254: * @return the value of the '<em>Traverse Xlink Depth</em>' attribute.
255: * @see #setTraverseXlinkDepth(String)
256: * @see net.opengis.wfs.WfsPackage#getGetFeatureType_TraverseXlinkDepth()
257: * @model unique="false" dataType="org.eclipse.emf.ecore.xml.type.String"
258: * extendedMetaData="kind='attribute' name='traverseXlinkDepth'"
259: * @generated
260: */
261: String getTraverseXlinkDepth();
262:
263: /**
264: * Sets the value of the '{@link net.opengis.wfs.GetFeatureType#getTraverseXlinkDepth <em>Traverse Xlink Depth</em>}' attribute.
265: * <!-- begin-user-doc -->
266: * <!-- end-user-doc -->
267: * @param value the new value of the '<em>Traverse Xlink Depth</em>' attribute.
268: * @see #getTraverseXlinkDepth()
269: * @generated
270: */
271: void setTraverseXlinkDepth(String value);
272:
273: /**
274: * Returns the value of the '<em><b>Traverse Xlink Expiry</b></em>' attribute.
275: * <!-- begin-user-doc -->
276: * <!-- end-user-doc -->
277: * <!-- begin-model-doc -->
278: *
279: * The traverseXlinkExpiry attribute value is specified in
280: * minutes. It indicates how long a Web Feature Service
281: * should wait to receive a response to a nested GetGmlObject
282: * request.
283: * This attribute is only relevant if a value is specified
284: * for the traverseXlinkDepth attribute.
285: * <!-- end-model-doc -->
286: * @return the value of the '<em>Traverse Xlink Expiry</em>' attribute.
287: * @see #setTraverseXlinkExpiry(BigInteger)
288: * @see net.opengis.wfs.WfsPackage#getGetFeatureType_TraverseXlinkExpiry()
289: * @model unique="false" dataType="org.eclipse.emf.ecore.xml.type.PositiveInteger"
290: * extendedMetaData="kind='attribute' name='traverseXlinkExpiry'"
291: * @generated
292: */
293: BigInteger getTraverseXlinkExpiry();
294:
295: /**
296: * Sets the value of the '{@link net.opengis.wfs.GetFeatureType#getTraverseXlinkExpiry <em>Traverse Xlink Expiry</em>}' attribute.
297: * <!-- begin-user-doc -->
298: * <!-- end-user-doc -->
299: * @param value the new value of the '<em>Traverse Xlink Expiry</em>' attribute.
300: * @see #getTraverseXlinkExpiry()
301: * @generated
302: */
303: void setTraverseXlinkExpiry(BigInteger value);
304:
305: } // GetFeatureType
|