net.opengis.wfs
Interface GetGmlObjectType

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

public interface GetGmlObjectType
extends BaseRequestType

A representation of the model object 'Get Gml Object Type'. A GetGmlObjectType element contains exactly one GmlObjectId. The value of the gml:id attribute on that GmlObjectId is used as a unique key to retrieve the complex element with a gml:id attribute with the same value.

The following features are supported:

See Also:
WfsPackage.getGetGmlObjectType()

Method Summary
 org.opengis.filter.identity.GmlObjectId getGmlObjectId()
          Returns the value of the 'Gml Object Id' attribute.
 java.lang.String getOutputFormat()
          Returns the value of the 'Output Format' attribute.
 java.lang.String getTraverseXlinkDepth()
          Returns the value of the 'Traverse Xlink Depth' attribute.
 java.math.BigInteger getTraverseXlinkExpiry()
          Returns the value of the 'Traverse Xlink Expiry' attribute.
 boolean isSetOutputFormat()
          Returns whether the value of the 'Output Format' attribute is set.
 void setGmlObjectId(org.opengis.filter.identity.GmlObjectId value)
          Sets the value of the 'Gml Object Id' attribute.
 void setOutputFormat(java.lang.String value)
          Sets the value of the 'Output Format' attribute.
 void setTraverseXlinkDepth(java.lang.String value)
          Sets the value of the 'Traverse Xlink Depth' attribute.
 void setTraverseXlinkExpiry(java.math.BigInteger value)
          Sets the value of the 'Traverse Xlink Expiry' attribute.
 void unsetOutputFormat()
          Unsets the value of the 'Output Format' attribute.
 
Methods inherited from interface net.opengis.wfs.BaseRequestType
getBaseUrl, getHandle, getProvidedVersion, getService, getVersion, isSetService, isSetVersion, setBaseUrl, setHandle, setProvidedVersion, setService, setVersion, unsetService, unsetVersion
 
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

getGmlObjectId

org.opengis.filter.identity.GmlObjectId getGmlObjectId()
Returns the value of the 'Gml Object Id' attribute.

If the meaning of the 'Gml Object Id' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Gml Object Id' attribute.
See Also:
#setGmlObjectId(Object), WfsPackage.getGetGmlObjectType_GmlObjectId()

setGmlObjectId

void setGmlObjectId(org.opengis.filter.identity.GmlObjectId value)
Sets the value of the 'Gml Object Id' attribute.

Parameters:
value - the new value of the 'Gml Object Id' attribute.
See Also:
getGmlObjectId()

getOutputFormat

java.lang.String getOutputFormat()
Returns the value of the 'Output Format' attribute. The default value is "GML3".

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

Returns:
the value of the 'Output Format' attribute.
See Also:
isSetOutputFormat(), unsetOutputFormat(), setOutputFormat(String), WfsPackage.getGetGmlObjectType_OutputFormat()

setOutputFormat

void setOutputFormat(java.lang.String value)
Sets the value of the 'Output Format' attribute.

Parameters:
value - the new value of the 'Output Format' attribute.
See Also:
isSetOutputFormat(), unsetOutputFormat(), getOutputFormat()

unsetOutputFormat

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

See Also:
isSetOutputFormat(), getOutputFormat(), setOutputFormat(String)

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:
unsetOutputFormat(), getOutputFormat(), setOutputFormat(String)

getTraverseXlinkDepth

java.lang.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 " ".

Returns:
the value of the 'Traverse Xlink Depth' attribute.
See Also:
setTraverseXlinkDepth(String), WfsPackage.getGetGmlObjectType_TraverseXlinkDepth()

setTraverseXlinkDepth

void setTraverseXlinkDepth(java.lang.String value)
Sets the value of the 'Traverse Xlink Depth' attribute.

Parameters:
value - the new value of the 'Traverse Xlink Depth' attribute.
See Also:
getTraverseXlinkDepth()

getTraverseXlinkExpiry

java.math.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.

Returns:
the value of the 'Traverse Xlink Expiry' attribute.
See Also:
setTraverseXlinkExpiry(BigInteger), WfsPackage.getGetGmlObjectType_TraverseXlinkExpiry()

setTraverseXlinkExpiry

void setTraverseXlinkExpiry(java.math.BigInteger value)
Sets the value of the 'Traverse Xlink Expiry' attribute.

Parameters:
value - the new value of the 'Traverse Xlink Expiry' attribute.
See Also:
getTraverseXlinkExpiry()


Copyright © 1996-2010 Geotools. All Rights Reserved.