org.deegree.services.wcs.protocol
Interface WCSGetCoverageRequest

All Superinterfaces:

OGCWebServiceRequest

All Known Implementing Classes:

WCSGetCoverageRequest_Impl

public interface WCSGetCoverageRequest

extends OGCWebServiceRequest

defines the encapsulating of the WCS GetCoverage operation

method comments are taken from OGC WCS specification 0.7

------------------------------------------------------------------------

Version:

31.10.2002

Author:

Andreas Poth

Method Summary

GM_Envelope	getBoundingBox() GetCoverage queries must express spatial constraints in at least 2-D (XY) coordinate space, using a BBOX parameter with comma-separated numbers (minx, miny, maxx, maxy), expressed in the spatial reference system given in the SRS parameter.
int	getDepth()
java.lang.String	getExceptions() A Web Coverage Service must offer the exception reporting format application/vnd.ogc.se_xml by listing it in a element in its Capabilities XML.
java.lang.String	getFormat() The value of this parameter must be one of those listed in the Format element of the desired coverage layer in Capabilities XML.
int	getHeight()
java.lang.String	getInterpolationMethod() specifies what type of interpolation to use for resampling coverage values over the spatial domain.
java.lang.String	getLayer() The LAYER parameter requests a single coverage layer, identified in the Capabilities XML by a LayerID element.
RangeParamList	getRangeList() RangeParamList contains all the range parameter, including the special ranges "time" and "elevation".
java.lang.String	getResponseSRS() This parameter specifies the coordinate system in which the coverage response should be referenced.
double	getResX() GetCoverage queries for gridded coverages may request coverage replies in specific grid resolution.
double	getResY()
double	getResZ()
java.lang.String	getSRS() The SRS (Spatial Reference System) parameter is specified in the Basic Service Elements section.
int	getWidth() GetCoverage queries for gridded coverages may request coverage replies with a specific grid size.

Methods inherited from interface org.deegree.services.OGCWebServiceRequest

getId, getRequest, getRequestParameter, getService, getVendorSpecificParameter, getVendorSpecificParameters, getVersion

Method Detail

getLayer

public java.lang.String getLayer()

The LAYER parameter requests a single coverage layer, identified in the Capabilities XML by a LayerID element.

getSRS

public java.lang.String getSRS()

The SRS (Spatial Reference System) parameter is specified in the Basic Service Elements section.

GetCoverage requests must use this parameter to specify the coordinate reference system in which the query (BBOX) is expressed. The values of this request parameter must be one of those defined in a SRS or QuerySRS/SRS element under the requested coverage layer.

getResponseSRS

public java.lang.String getResponseSRS()

This parameter specifies the coordinate system in which the coverage response should be referenced. This parameter is optional; its value defaults to that of SRS. Thus, omitting it requests a coverage response referenced in the same coordinate reference system as the query (like WMS and WFS).

The value of this request parameter must be one of those defined in a SRS or ResponseSRS/SRS element defined under the requested coverage layer

getBoundingBox

public GM_Envelope getBoundingBox()

GetCoverage queries must express spatial constraints in at least 2-D (XY) coordinate space, using a BBOX parameter with comma-separated numbers (minx, miny, maxx, maxy), expressed in the spatial reference system given in the SRS parameter.

For any part of the coverage domain that is partly or entirely contained in the Bounding Box defined by BBOX, the server should return coverage data in the appropriate format.

In addition, if the Capabilities XML expresses the Layers domain as a 3-D bounding box in a 3D coordinate reference system, then GetCoverage queries may use an extended BBOX syntax (BBOX=minx,miny,maxx,maxy,minz,maxz), as described in the Basic Services Model. These extra numbers are optional: omitting minz,maxz requests the coverage layers default elevation (if defined).

getRangeList

public RangeParamList getRangeList()

RangeParamList contains all the range parameter, including the special ranges "time" and "elevation".

Returns:

the RangeParamList

getWidth

public int getWidth()

GetCoverage queries for gridded coverages may request coverage replies with a specific grid size. The parameters WIDTH, HEIGHT, DEPTH define the grid size (number of gridpoints or cells) along the three axes of the grid.

Either these parameters or RESX, RESY, RESZ are normally required for grid coverage layers. However, if the Capabilities XML reports only the Interpolation method None for the queried coverage layer, then GetCoverage queries must be for the full native resolution of the data: they may not use RESX, RESY, RESZ or WIDTH, HEIGHT, DEPTH to change the coverage resolution. In this case, BBOX alone is used for subsetting.

If the coverage layer has elevation extents expressed separately from its BoundingBox, then GetCoverage queries may use ELEVATION= as described previously to request a particular extent and resolution.

getHeight

public int getHeight()

See Also:

getWidth()

getDepth

public int getDepth()

See Also:

getWidth()

getResX

public double getResX()

GetCoverage queries for gridded coverages may request coverage replies in specific grid resolution. The parameters RESX and RESY define the grid-cell size along the first and second axes of the coordinate reference system given in SRS or RESPONSE_SRS.

If the RESPONSE_SRS is a 3D spatial reference system, then the additional RESZ parameter may be used to specify the desired resolution along the third axis of that spatial reference system.

Either these parameters or WIDTH, HEIGHT, DEPTH are normally required for grid coverage layers. However, if the Capabilities XML reports only the Interpolation method None for the queried coverage layer, then GetCoverage queries must be for the full native resolution of the data: they may not use RESX, RESY, RESZ or WIDTH, HEIGHT, DEPTH to change the coverage resolution. In this case, BBOX alone is used for subsetting.

If the coveage layer has elevation extents expressed separately from its BoundingBox, then GetCoverage queries may use ELEVATION= as described previously to request a particular extent and resolution.

getResY

public double getResY()

See Also:

getResX()

getResZ

public double getResZ()

See Also:

getResX()

getFormat

public java.lang.String getFormat()

The value of this parameter must be one of those listed in the Format element of the desired coverage layer in Capabilities XML. The entire MIME type string in the MIMEType sub-element is used as the value of the FORMAT parameter. In an HTTP environment, the MIME type must be set on the returned object using the Content-type entity header

getInterpolationMethod

public java.lang.String getInterpolationMethod()

specifies what type of interpolation to use for resampling coverage values over the spatial domain. This must be one of those listed for this coverage layer in Capabilities XML. Options are "linear", "bilinear", "bicubic", "lost area, "barycentric, "piecewise constant", and "none".

getExceptions

public java.lang.String getExceptions()

A Web Coverage Service must offer the exception reporting format application/vnd.ogc.se_xml by listing it in a element in its Capabilities XML. The entire MIME type string in is used as the value of the EXCEPTIONS parameter.

Errors are reported using Service Exception XML, as specified in WMS 1.1 Section 6.7 and Annex A.3. This is the default exception format if none is specified in the request.