org.deegree.protocol.wfs.getgmlobject
Class GetGmlObject

java.lang.Object
  extended by org.deegree.protocol.wfs.AbstractWFSRequest
      extended by org.deegree.protocol.wfs.getgmlobject.GetGmlObject

public class GetGmlObject
extends AbstractWFSRequest

Represents a GetGmlObject request to a WFS.

Supported versions:

Version:
$Revision: $, $Date: $
Author:
Markus Schneider, Andrei Ionita, last edited by: $Author: schneider $

Constructor Summary
GetGmlObject(Version version, String handle, String requestedId, String outputFormat, String traverseXlinkDepth, Integer traverseXlinkExpiry)
          Creates a new GetGmlObject request.
 
Method Summary
 String getOutputFormat()
          Returns the requested output format.
 String getRequestedId()
          Returns the id of the requested object.
 String getTraverseXlinkDepth()
          Returns the depth to which nested property XLink linking element locator attribute (href) XLinks are traversed and resolved if possible.
 Integer getTraverseXlinkExpiry()
          Return the number of minutes that the WFS should wait to receive a response to a nested GetGmlObject request.
 
Methods inherited from class org.deegree.protocol.wfs.AbstractWFSRequest
getHandle, getVersion
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetGmlObject

public GetGmlObject(Version version,
                    String handle,
                    String requestedId,
                    String outputFormat,
                    String traverseXlinkDepth,
                    Integer traverseXlinkExpiry)
Creates a new GetGmlObject request.

Parameters:
version - protocol version, must not be null
handle - client-generated identifier, may be null
requestedId - the id of the requested object, must not be null
outputFormat - a String format of the result set, may be null
traverseXlinkDepth - the depth to which nested property XLink linking element locator attribute (href) XLinks are traversed and resolved if possible, the range of valid values for this parameter consists of positive integers, "*" (unlimited) and null (unspecified)
traverseXlinkExpiry - indicates how long the WFS should wait to receive a response to a nested GetGmlObject request (in minutes), this attribute is only relevant if a value is specified for the traverseXlinkDepth attribute, may be null
Method Detail

getRequestedId

public String getRequestedId()
Returns the id of the requested object.

Returns:
the id of the requested object, never null

getOutputFormat

public String getOutputFormat()
Returns the requested output format.

Returns:
the requested output format, or null if unspecified

getTraverseXlinkDepth

public String getTraverseXlinkDepth()
Returns the depth to which nested property XLink linking element locator attribute (href) XLinks are traversed and resolved if possible. The range of valid values for this parameter consists of positive integers, "*" (unlimited) and null (unspecified).

Returns:
the depth (positive integer), "*" (unlimited) or null (unspecified)

getTraverseXlinkExpiry

public Integer getTraverseXlinkExpiry()
Return the number of minutes that the WFS should wait to receive a response to a nested GetGmlObject request. This is only relevant if a value is specified for the traverseXlinkDepth parameter.

Returns:
the number of minutes to wait for nested GetGmlObject responses (positive integer) or null (unspecified)


Copyright © 2011. All Rights Reserved.