deegree 2.3 (2010/04/09 10:10 build-4-official)

org.deegree.ogcwebservices.wpvs.operation
Class Get3DFeatureInfo

java.lang.Object
  extended by org.deegree.ogcwebservices.AbstractOGCWebServiceRequest
      extended by org.deegree.ogcwebservices.wpvs.operation.Get3DFeatureInfo
All Implemented Interfaces:
Serializable, OGCWebServiceRequest

public class Get3DFeatureInfo
extends AbstractOGCWebServiceRequest

This Class handles a kvp encoded Get3DFeatureInfo-request and stores it's values.

Version:
$Revision: $, 1.0. $Revision: $, $Date: $
Author:
Lyn Buesching, last edited by: $Author: $
See Also:
Serialized Form

Method Summary
static Get3DFeatureInfo create(Map<String,String> param)
          creates a WPVSFeatureInfoRequest from a HashMap that contains the request parameters as key-value-pairs.
 float getApexAngle()
          The AA Parameter indicates the apex angle of a request with a cone
 Point getClickPoint()
          The I and J parameters indicate a point of interest on the map.
 float getDepth()
          This optional parameter indicates the depth of a query
 String getExceptions()
          The optional EXCEPTIONS parameter states the manner in which errors are to be reported to the client.
 int getFeatureCount()
           
 GetView getGetViewRequestCopy()
           is not a name/value pair like the other parameters.
 String getInfoFormat()
          The optional INFO_FORMAT indicates what format to use when returning the feature information.
 boolean getParent()
           
 Rectangle getQueryBox()
          The parameter QueryBox indicates the rectangle for the Request with a pyramid
 List<String> getQueryDatasets()
          The required QUERY_LAYERS parameter states the map layer(s) from which feature information is desired to be retrieved.
 int getRadius()
           
 String getServiceName()
           
 
Methods inherited from class org.deegree.ogcwebservices.AbstractOGCWebServiceRequest
getId, getParam, getParamAsInt, getParamValues, getRequestParameter, getRequiredParam, getVendorSpecificParameter, getVendorSpecificParameters, getVersion, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

create

public static Get3DFeatureInfo create(Map<String,String> param)
                               throws OGCWebServiceException
creates a WPVSFeatureInfoRequest from a HashMap that contains the request parameters as key-value-pairs.

Parameters:
param - HashMap containing the request parameters
Returns:
an instance of WPVSFeatureInfoRequest
Throws:
OGCWebServiceException

getServiceName

public String getServiceName()
Returns:
the name of the service that is targeted by the request

getApexAngle

public float getApexAngle()
The AA Parameter indicates the apex angle of a request with a cone

Returns:
the apex angle

getClickPoint

public Point getClickPoint()
The I and J parameters indicate a point of interest on the map. Used by the request with a line or cone. The origin is set to (0,0) centered in the pixel at the upper left corner; I increases to the right and J increases downward. I and J are returned as java.awt.Point class/datastructure.

Returns:
the point of interest

getDepth

public float getDepth()
This optional parameter indicates the depth of a query

Returns:
the depth

getExceptions

public String getExceptions()
The optional EXCEPTIONS parameter states the manner in which errors are to be reported to the client. The default value is application/vnd.ogc.se_xml if this parameter is absent from the request.

Returns:
the exception format

getGetViewRequestCopy

public GetView getGetViewRequestCopy()
is not a name/value pair like the other parameters. Instead, most of the GetView request parameters that generated the original map are repeated. Two are omitted because Get3DFeatureInfo provides its own values: VERSION and REQUEST. The remainder of the GetView request shall be embedded contiguously in the Get3DFeatureInfo request.

Returns:
a copy of the original request

getInfoFormat

public String getInfoFormat()
The optional INFO_FORMAT indicates what format to use when returning the feature information. Supported values for a Get3DFeatureInfo request on a WPVS instance are listed as MIME types in one or more elements inside the element of its Capabilities XML. The entire MIME type string in is used as the value of the INFO_FORMAT parameter. In an HTTP environment, the MIME type shall be set on the returned object using the Content-type entity header.

EXAMPLE: The parameter INFO_FORMAT=application/vnd.ogc.gml requests that the feature information be formatted in Geography Markup Language (GML).

Returns:
the format

getQueryDatasets

public List<String> getQueryDatasets()
The required QUERY_LAYERS parameter states the map layer(s) from which feature information is desired to be retrieved. Its value is a comma- separated list of one or more map layers that are returned as an array. This parameter shall contain at least one layer name, but may contain fewer layers than the original GetView request.

If any layer in this list is not contained in the Capabilities XML of the WPVS, the results are undefined and the WPVS shall produce an exception response.

Returns:
the layer names

getParent

public boolean getParent()
Returns:
true if a parent is available.

getFeatureCount

public int getFeatureCount()
Returns:
the number of features.

getQueryBox

public Rectangle getQueryBox()
The parameter QueryBox indicates the rectangle for the Request with a pyramid

Returns:
the queryBox

getRadius

public int getRadius()
Returns:
the radius of a feature info request.

deegree 2.3 (2010/04/09 10:10 build-4-official)

an open source project founded by lat/lon, Bonn, Germany.
For more information visit: http://www.deegree.org