net.opengis.wfs
Interface DocumentRoot

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

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

A representation of the model object 'Document Root'.

The following features are supported:

See Also:
WfsPackage.getDocumentRoot()

Method Summary
 DeleteElementType getDelete()
          Returns the value of the 'Delete' containment reference.
 DescribeFeatureTypeType getDescribeFeatureType()
          Returns the value of the 'Describe Feature Type' containment reference.
 FeatureCollectionType getFeatureCollection()
          Returns the value of the 'Feature Collection' containment reference.
 FeatureTypeListType getFeatureTypeList()
          Returns the value of the 'Feature Type List' containment reference.
 GetCapabilitiesType getGetCapabilities()
          Returns the value of the 'Get Capabilities' containment reference.
 GetFeatureType getGetFeature()
          Returns the value of the 'Get Feature' containment reference.
 GetFeatureWithLockType getGetFeatureWithLock()
          Returns the value of the 'Get Feature With Lock' containment reference.
 GetGmlObjectType getGetGmlObject()
          Returns the value of the 'Get Gml Object' containment reference.
 InsertElementType getInsert()
          Returns the value of the 'Insert' containment reference.
 LockFeatureType getLockFeature()
          Returns the value of the 'Lock Feature' containment reference.
 LockFeatureResponseType getLockFeatureResponse()
          Returns the value of the 'Lock Feature Response' containment reference.
 java.lang.String getLockId()
          Returns the value of the 'Lock Id' attribute.
 org.eclipse.emf.ecore.util.FeatureMap getMixed()
          Returns the value of the 'Mixed' attribute list.
 NativeType getNative()
          Returns the value of the 'Native' containment reference.
 PropertyType getProperty()
          Returns the value of the 'Property' containment reference.
 java.lang.String getPropertyName()
          Returns the value of the 'Property Name' attribute.
 QueryType getQuery()
          Returns the value of the 'Query' containment reference.
 GMLObjectTypeListType getServesGMLObjectTypeList()
          Returns the value of the 'Serves GML Object Type List' containment reference.
 GMLObjectTypeListType getSupportsGMLObjectTypeList()
          Returns the value of the 'Supports GML Object Type List' containment reference.
 TransactionType getTransaction()
          Returns the value of the 'Transaction' containment reference.
 TransactionResponseType getTransactionResponse()
          Returns the value of the 'Transaction Response' containment reference.
 UpdateElementType getUpdate()
          Returns the value of the 'Update' containment reference.
 WFSCapabilitiesType getWfsCapabilities()
          Returns the value of the 'Wfs Capabilities' containment reference.
 XlinkPropertyNameType getXlinkPropertyName()
          Returns the value of the 'Xlink Property Name' containment reference.
 org.eclipse.emf.common.util.EMap getXMLNSPrefixMap()
          Returns the value of the 'XMLNS Prefix Map' map.
 org.eclipse.emf.common.util.EMap getXSISchemaLocation()
          Returns the value of the 'XSI Schema Location' map.
 void setDelete(DeleteElementType value)
          Sets the value of the 'Delete' containment reference.
 void setDescribeFeatureType(DescribeFeatureTypeType value)
          Sets the value of the 'Describe Feature Type' containment reference.
 void setFeatureCollection(FeatureCollectionType value)
          Sets the value of the 'Feature Collection' containment reference.
 void setFeatureTypeList(FeatureTypeListType value)
          Sets the value of the 'Feature Type List' containment reference.
 void setGetCapabilities(GetCapabilitiesType value)
          Sets the value of the 'Get Capabilities' containment reference.
 void setGetFeature(GetFeatureType value)
          Sets the value of the 'Get Feature' containment reference.
 void setGetFeatureWithLock(GetFeatureWithLockType value)
          Sets the value of the 'Get Feature With Lock' containment reference.
 void setGetGmlObject(GetGmlObjectType value)
          Sets the value of the 'Get Gml Object' containment reference.
 void setInsert(InsertElementType value)
          Sets the value of the 'Insert' containment reference.
 void setLockFeature(LockFeatureType value)
          Sets the value of the 'Lock Feature' containment reference.
 void setLockFeatureResponse(LockFeatureResponseType value)
          Sets the value of the 'Lock Feature Response' containment reference.
 void setLockId(java.lang.String value)
          Sets the value of the 'Lock Id' attribute.
 void setNative(NativeType value)
          Sets the value of the 'Native' containment reference.
 void setProperty(PropertyType value)
          Sets the value of the 'Property' containment reference.
 void setPropertyName(java.lang.String value)
          Sets the value of the 'Property Name' attribute.
 void setQuery(QueryType value)
          Sets the value of the 'Query' containment reference.
 void setServesGMLObjectTypeList(GMLObjectTypeListType value)
          Sets the value of the 'Serves GML Object Type List' containment reference.
 void setSupportsGMLObjectTypeList(GMLObjectTypeListType value)
          Sets the value of the 'Supports GML Object Type List' containment reference.
 void setTransaction(TransactionType value)
          Sets the value of the 'Transaction' containment reference.
 void setTransactionResponse(TransactionResponseType value)
          Sets the value of the 'Transaction Response' containment reference.
 void setUpdate(UpdateElementType value)
          Sets the value of the 'Update' containment reference.
 void setWfsCapabilities(WFSCapabilitiesType value)
          Sets the value of the 'Wfs Capabilities' containment reference.
 void setXlinkPropertyName(XlinkPropertyNameType value)
          Sets the value of the 'Xlink Property Name' containment reference.
 
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

getMixed

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

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

Returns:
the value of the 'Mixed' attribute list.
See Also:
WfsPackage.getDocumentRoot_Mixed()

getXMLNSPrefixMap

org.eclipse.emf.common.util.EMap getXMLNSPrefixMap()
Returns the value of the 'XMLNS Prefix Map' map. The key is of type String, and the value is of type String,

If the meaning of the 'XMLNS Prefix Map' map isn't clear, there really should be more of a description here...

Returns:
the value of the 'XMLNS Prefix Map' map.
See Also:
WfsPackage.getDocumentRoot_XMLNSPrefixMap()

getXSISchemaLocation

org.eclipse.emf.common.util.EMap getXSISchemaLocation()
Returns the value of the 'XSI Schema Location' map. The key is of type String, and the value is of type String,

If the meaning of the 'XSI Schema Location' map isn't clear, there really should be more of a description here...

Returns:
the value of the 'XSI Schema Location' map.
See Also:
WfsPackage.getDocumentRoot_XSISchemaLocation()

getDelete

DeleteElementType getDelete()
Returns the value of the 'Delete' containment reference. The Delete element is used to indicate that one or more feature instances should be removed from the feature repository.

Returns:
the value of the 'Delete' containment reference.
See Also:
setDelete(DeleteElementType), WfsPackage.getDocumentRoot_Delete()

setDelete

void setDelete(DeleteElementType value)
Sets the value of the 'Delete' containment reference.

Parameters:
value - the new value of the 'Delete' containment reference.
See Also:
getDelete()

getDescribeFeatureType

DescribeFeatureTypeType getDescribeFeatureType()
Returns the value of the 'Describe Feature Type' containment reference. The DescribeFeatureType element is used to request that a Web Feature Service generate a document describing one or more feature types.

Returns:
the value of the 'Describe Feature Type' containment reference.
See Also:
setDescribeFeatureType(DescribeFeatureTypeType), WfsPackage.getDocumentRoot_DescribeFeatureType()

setDescribeFeatureType

void setDescribeFeatureType(DescribeFeatureTypeType value)
Sets the value of the 'Describe Feature Type' containment reference.

Parameters:
value - the new value of the 'Describe Feature Type' containment reference.
See Also:
getDescribeFeatureType()

getFeatureCollection

FeatureCollectionType getFeatureCollection()
Returns the value of the 'Feature Collection' containment reference. This element is a container for the response to a GetFeature or GetFeatureWithLock (WFS-transaction.xsd) request.

Returns:
the value of the 'Feature Collection' containment reference.
See Also:
setFeatureCollection(FeatureCollectionType), WfsPackage.getDocumentRoot_FeatureCollection()

setFeatureCollection

void setFeatureCollection(FeatureCollectionType value)
Sets the value of the 'Feature Collection' containment reference.

Parameters:
value - the new value of the 'Feature Collection' containment reference.
See Also:
getFeatureCollection()

getFeatureTypeList

FeatureTypeListType getFeatureTypeList()
Returns the value of the 'Feature Type List' containment reference.

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

Returns:
the value of the 'Feature Type List' containment reference.
See Also:
setFeatureTypeList(FeatureTypeListType), WfsPackage.getDocumentRoot_FeatureTypeList()

setFeatureTypeList

void setFeatureTypeList(FeatureTypeListType value)
Sets the value of the 'Feature Type List' containment reference.

Parameters:
value - the new value of the 'Feature Type List' containment reference.
See Also:
getFeatureTypeList()

getGetCapabilities

GetCapabilitiesType getGetCapabilities()
Returns the value of the 'Get Capabilities' containment reference.

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

Returns:
the value of the 'Get Capabilities' containment reference.
See Also:
setGetCapabilities(GetCapabilitiesType), WfsPackage.getDocumentRoot_GetCapabilities()

setGetCapabilities

void setGetCapabilities(GetCapabilitiesType value)
Sets the value of the 'Get Capabilities' containment reference.

Parameters:
value - the new value of the 'Get Capabilities' containment reference.
See Also:
getGetCapabilities()

getGetFeature

GetFeatureType getGetFeature()
Returns the value of the 'Get Feature' containment reference. The GetFeature element is used to request that a Web Feature Service return feature type instances of one or more feature types.

Returns:
the value of the 'Get Feature' containment reference.
See Also:
setGetFeature(GetFeatureType), WfsPackage.getDocumentRoot_GetFeature()

setGetFeature

void setGetFeature(GetFeatureType value)
Sets the value of the 'Get Feature' containment reference.

Parameters:
value - the new value of the 'Get Feature' containment reference.
See Also:
getGetFeature()

getGetFeatureWithLock

GetFeatureWithLockType getGetFeatureWithLock()
Returns the value of the 'Get Feature With Lock' containment reference. This is the root element for the GetFeatureWithLock request. The GetFeatureWithLock operation performs identically to a GetFeature request except that the GetFeatureWithLock request locks all the feature instances in the result set and returns a lock identifier to a client application in the response. The lock identifier is returned to the client application using the lockId attribute define on the wfs:FeatureCollection element.

Returns:
the value of the 'Get Feature With Lock' containment reference.
See Also:
setGetFeatureWithLock(GetFeatureWithLockType), WfsPackage.getDocumentRoot_GetFeatureWithLock()

setGetFeatureWithLock

void setGetFeatureWithLock(GetFeatureWithLockType value)
Sets the value of the 'Get Feature With Lock' containment reference.

Parameters:
value - the new value of the 'Get Feature With Lock' containment reference.
See Also:
getGetFeatureWithLock()

getGetGmlObject

GetGmlObjectType getGetGmlObject()
Returns the value of the 'Get Gml Object' containment reference. The GetGmlObject element is used to request that a Web Feature Service return an element with a gml:id attribute value specified by an ogc:GmlObjectId.

Returns:
the value of the 'Get Gml Object' containment reference.
See Also:
setGetGmlObject(GetGmlObjectType), WfsPackage.getDocumentRoot_GetGmlObject()

setGetGmlObject

void setGetGmlObject(GetGmlObjectType value)
Sets the value of the 'Get Gml Object' containment reference.

Parameters:
value - the new value of the 'Get Gml Object' containment reference.
See Also:
getGetGmlObject()

getInsert

InsertElementType getInsert()
Returns the value of the 'Insert' containment reference. The Insert element is used to indicate that the Web Feature Service should create a new instance of a feature type. The feature instance is specified using GML3 and one or more feature instances to be created can be contained inside the Insert element.

Returns:
the value of the 'Insert' containment reference.
See Also:
setInsert(InsertElementType), WfsPackage.getDocumentRoot_Insert()

setInsert

void setInsert(InsertElementType value)
Sets the value of the 'Insert' containment reference.

Parameters:
value - the new value of the 'Insert' containment reference.
See Also:
getInsert()

getLockFeature

LockFeatureType getLockFeature()
Returns the value of the 'Lock Feature' containment reference. This is the root element for a LockFeature request. The LockFeature request can be used to lock one or more feature instances.

Returns:
the value of the 'Lock Feature' containment reference.
See Also:
setLockFeature(LockFeatureType), WfsPackage.getDocumentRoot_LockFeature()

setLockFeature

void setLockFeature(LockFeatureType value)
Sets the value of the 'Lock Feature' containment reference.

Parameters:
value - the new value of the 'Lock Feature' containment reference.
See Also:
getLockFeature()

getLockFeatureResponse

LockFeatureResponseType getLockFeatureResponse()
Returns the value of the 'Lock Feature Response' containment reference. The LockFeatureResponse element contains a report about the completion status of a LockFeature request.

Returns:
the value of the 'Lock Feature Response' containment reference.
See Also:
setLockFeatureResponse(LockFeatureResponseType), WfsPackage.getDocumentRoot_LockFeatureResponse()

setLockFeatureResponse

void setLockFeatureResponse(LockFeatureResponseType value)
Sets the value of the 'Lock Feature Response' containment reference.

Parameters:
value - the new value of the 'Lock Feature Response' containment reference.
See Also:
getLockFeatureResponse()

getLockId

java.lang.String getLockId()
Returns the value of the 'Lock Id' attribute. The LockId element contains the value of the lock identifier obtained by a client application from a previous GetFeatureWithLock or LockFeature request.

Returns:
the value of the 'Lock Id' attribute.
See Also:
setLockId(String), WfsPackage.getDocumentRoot_LockId()

setLockId

void setLockId(java.lang.String value)
Sets the value of the 'Lock Id' attribute.

Parameters:
value - the new value of the 'Lock Id' attribute.
See Also:
getLockId()

getNative

NativeType getNative()
Returns the value of the 'Native' containment reference. Many times, a Web Feature Service interacts with a repository that may have special vendor specific capabilities. The native element allows vendor specific command to be passed to the repository via the Web Feature Service.

Returns:
the value of the 'Native' containment reference.
See Also:
setNative(NativeType), WfsPackage.getDocumentRoot_Native()

setNative

void setNative(NativeType value)
Sets the value of the 'Native' containment reference.

Parameters:
value - the new value of the 'Native' containment reference.
See Also:
getNative()

getProperty

PropertyType getProperty()
Returns the value of the 'Property' containment reference. The Property element is used to specify the new value of a feature property inside an Update element.

Returns:
the value of the 'Property' containment reference.
See Also:
setProperty(PropertyType), WfsPackage.getDocumentRoot_Property()

setProperty

void setProperty(PropertyType value)
Sets the value of the 'Property' containment reference.

Parameters:
value - the new value of the 'Property' containment reference.
See Also:
getProperty()

getPropertyName

java.lang.String 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), WfsPackage.getDocumentRoot_PropertyName()

setPropertyName

void setPropertyName(java.lang.String value)
Sets the value of the 'Property Name' attribute.

Parameters:
value - the new value of the 'Property Name' attribute.
See Also:
getPropertyName()

getQuery

QueryType getQuery()
Returns the value of the 'Query' containment reference. The Query element is used to describe a single query. One or more Query elements can be specified inside a GetFeature element so that multiple queries can be executed in one request. The output from the various queries are combined in a wfs:FeatureCollection element to form the response document.

Returns:
the value of the 'Query' containment reference.
See Also:
setQuery(QueryType), WfsPackage.getDocumentRoot_Query()

setQuery

void setQuery(QueryType value)
Sets the value of the 'Query' containment reference.

Parameters:
value - the new value of the 'Query' containment reference.
See Also:
getQuery()

getServesGMLObjectTypeList

GMLObjectTypeListType getServesGMLObjectTypeList()
Returns the value of the 'Serves GML Object Type List' containment reference. List of GML Object types available for GetGmlObject requests

Returns:
the value of the 'Serves GML Object Type List' containment reference.
See Also:
setServesGMLObjectTypeList(GMLObjectTypeListType), WfsPackage.getDocumentRoot_ServesGMLObjectTypeList()

setServesGMLObjectTypeList

void setServesGMLObjectTypeList(GMLObjectTypeListType value)
Sets the value of the 'Serves GML Object Type List' containment reference.

Parameters:
value - the new value of the 'Serves GML Object Type List' containment reference.
See Also:
getServesGMLObjectTypeList()

getSupportsGMLObjectTypeList

GMLObjectTypeListType getSupportsGMLObjectTypeList()
Returns the value of the 'Supports GML Object Type List' containment reference. List of GML Object types that WFS is capable of serving, either directly, or as validly derived types defined in a GML application schema.

Returns:
the value of the 'Supports GML Object Type List' containment reference.
See Also:
setSupportsGMLObjectTypeList(GMLObjectTypeListType), WfsPackage.getDocumentRoot_SupportsGMLObjectTypeList()

setSupportsGMLObjectTypeList

void setSupportsGMLObjectTypeList(GMLObjectTypeListType value)
Sets the value of the 'Supports GML Object Type List' containment reference.

Parameters:
value - the new value of the 'Supports GML Object Type List' containment reference.
See Also:
getSupportsGMLObjectTypeList()

getTransaction

TransactionType getTransaction()
Returns the value of the 'Transaction' containment reference. This is the root element for a Transaction request. A transaction request allows insert, update and delete operations to be performed to create, change or remove feature instances.

Returns:
the value of the 'Transaction' containment reference.
See Also:
setTransaction(TransactionType), WfsPackage.getDocumentRoot_Transaction()

setTransaction

void setTransaction(TransactionType value)
Sets the value of the 'Transaction' containment reference.

Parameters:
value - the new value of the 'Transaction' containment reference.
See Also:
getTransaction()

getTransactionResponse

TransactionResponseType getTransactionResponse()
Returns the value of the 'Transaction Response' containment reference. The TransactionResponse element contains a report about the completion status of a Transaction operation.

Returns:
the value of the 'Transaction Response' containment reference.
See Also:
setTransactionResponse(TransactionResponseType), WfsPackage.getDocumentRoot_TransactionResponse()

setTransactionResponse

void setTransactionResponse(TransactionResponseType value)
Sets the value of the 'Transaction Response' containment reference.

Parameters:
value - the new value of the 'Transaction Response' containment reference.
See Also:
getTransactionResponse()

getUpdate

UpdateElementType getUpdate()
Returns the value of the 'Update' containment reference. One or more existing feature instances can be changed by using the Update element.

Returns:
the value of the 'Update' containment reference.
See Also:
setUpdate(UpdateElementType), WfsPackage.getDocumentRoot_Update()

setUpdate

void setUpdate(UpdateElementType value)
Sets the value of the 'Update' containment reference.

Parameters:
value - the new value of the 'Update' containment reference.
See Also:
getUpdate()

getWfsCapabilities

WFSCapabilitiesType getWfsCapabilities()
Returns the value of the 'Wfs Capabilities' containment reference.

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

Returns:
the value of the 'Wfs Capabilities' containment reference.
See Also:
setWfsCapabilities(WFSCapabilitiesType), WfsPackage.getDocumentRoot_WfsCapabilities()

setWfsCapabilities

void setWfsCapabilities(WFSCapabilitiesType value)
Sets the value of the 'Wfs Capabilities' containment reference.

Parameters:
value - the new value of the 'Wfs Capabilities' containment reference.
See Also:
getWfsCapabilities()

getXlinkPropertyName

XlinkPropertyNameType getXlinkPropertyName()
Returns the value of the 'Xlink Property Name' containment reference. This element may be used in place of an wfs:PropertyName element in a wfs:Query element in a wfs:GetFeature element to selectively request the traversal of nested XLinks in the returned element for the named property. This element may not be used in other requests -- GetFeatureWithLock, LockFeature, Insert, Update, Delete -- in this version of the WFS specification.

Returns:
the value of the 'Xlink Property Name' containment reference.
See Also:
setXlinkPropertyName(XlinkPropertyNameType), WfsPackage.getDocumentRoot_XlinkPropertyName()

setXlinkPropertyName

void setXlinkPropertyName(XlinkPropertyNameType value)
Sets the value of the 'Xlink Property Name' containment reference.

Parameters:
value - the new value of the 'Xlink Property Name' containment reference.
See Also:
getXlinkPropertyName()


Copyright © 1996-2010 Geotools. All Rights Reserved.