Package com.luciad.ogc.wcs.client

Class TLcdWCSGetCoverageRequest

java.lang.Object
com.luciad.ogc.wcs.client.TLcdWCSGetCoverageRequest
All Implemented Interfaces:
ILcdOWSRequest
public class TLcdWCSGetCoverageRequest extends Object implements ILcdOWSRequest
A WCS GetCoverage request. Instances of this class can be created using the TLcdWCSClient.createGetCoverageRequest() method. This method will ensure a request object is created that is compatible with the WCS version implemented by the WCS server.
Since:
8.2

  • Method Details

    • getTransportData

      public Object getTransportData()
      Returns an object representing data to be used by the transportation layer (see ILcdOWSTransport) to perform this OGC Web Service request. The type of object and the data contained in it depends on the ILcdOWSTransport object used to perform this request.

      An example in the case of a HTTP transport connection is a map of request properties (see URLConnection.getRequestProperties()) to be used for the request.

      Specified by:
      getTransportData in interface ILcdOWSRequest
      Returns:
      an object representing data to be used by the transportation layer to perform this OGC Web Service request.

    • setTransportData

      public void setTransportData(Object aTransportData)
      Sets an object representing data to be used by the transportation layer (see ILcdOWSTransport) to perform this OGC Web Service request. The type of object and the data contained in it depends on the ILcdOWSTransport object used to perform this request.
      Parameters:
      aTransportData - an object representing data to be used by the transportation layer to perform this OGC Web Service request.
      See Also:

    • setCoverageName

      public void setCoverageName(String aCoverageName)
      Sets the coverage name to query.
      Parameters:
      aCoverageName - a coverage name
      Throws:
      NullPointerException - if the coverage name is null

    • setRequestCRS

      public void setRequestCRS(String aCRS)
      Sets the coordinate reference system in which the request is expressed.
      Parameters:
      aCRS - the coordinate reference system in which the request is expressed
      Throws:
      NullPointerException - if the coordinate reference system is null

    • setResponseCRS

      public void setResponseCRS(String aCRS)
      Sets the coordinate reference system in which to express coverage responses.
      Parameters:
      aCRS - the coordinate reference system in which to express coverage responses.
      Throws:
      NullPointerException - if the coordinate reference system is null

    • setBoundingBox

      public void setBoundingBox(double aMinX, double aMaxX)
      Sets a bounding box to request a subset of the specified coverage. The bounding box should be expressed according to the request coordinate reference system (see setRequestCRS(String)).
      Parameters:
      aMinX - The minimum X coordinate of the bounding box
      aMaxX - The maximum X coordinate of the bounding box

    • setBoundingBox

      public void setBoundingBox(double aMinX, double aMaxX, double aMinY, double aMaxY)
      Sets a bounding box to request a subset of the specified coverage. The bounding box should be expressed according to the request coordinate reference system (see setRequestCRS(String)).
      Parameters:
      aMinX - The minimum X coordinate of the bounding box
      aMaxX - The maximum X coordinate of the bounding box
      aMinY - The minimum Y coordinate of the bounding box
      aMaxY - The maximum Y coordinate of the bounding box

    • setBoundingBox

      public void setBoundingBox(double aMinX, double aMaxX, double aMinY, double aMaxY, double aMinZ, double aMaxZ)
      Sets a bounding box to request a subset of the specified coverage. The bounding box should be expressed according to the request coordinate reference system (see setRequestCRS(String)).
      Parameters:
      aMinX - The minimum X coordinate of the bounding box
      aMaxX - The maximum X coordinate of the bounding box
      aMinY - The minimum Y coordinate of the bounding box
      aMaxY - The maximum Y coordinate of the bounding box
      aMinZ - The minimum Z coordinate of the bounding box
      aMaxZ - The maximum Z coordinate of the bounding box

    • setTimeInstants

      public void setTimeInstants(String[] aTimes)
      Sets one or more time instants to request a subset of the specified coverage. The time instants are expressed in an extended ISO 8601 syntax.
      Parameters:
      aTimes - time instants to request a subset of a coverage
      Throws:
      NullPointerException - if the time instant array is null or contains null values

    • setTimeIntervals

      public void setTimeIntervals(String[][] aTimeIntervals)
      Sets one or more time intervals to request a subset of the specified coverage. The time intervals are expressed in an extended ISO 8601 syntax.
      Parameters:
      aTimeIntervals - time intervals to request a subset of a coverage
      Throws:
      NullPointerException - if the time interval array is null or contains null values

    • setWidth

      public void setWidth(int aWidth)
      Sets a width for the requested coverage.
      Parameters:
      aWidth - a width for the requested coverage

    • setHeight

      public void setHeight(int aHeight)
      Sets a height for the requested coverage.
      Parameters:
      aHeight - a height for the requested coverage

    • setDepth

      public void setDepth(int aDepth)
      Sets a depth for the requested coverage.
      Parameters:
      aDepth - a depth for the requested coverage

    • setResX

      public void setResX(double aResX)
      Sets a spatial resolution along the X axis of the response coordinate reference system (see setResponseCRS(String)) for the requested coverage.
      Parameters:
      aResX - a spatial resolution along the X axis of the response CRS for the requested coverage

    • setResY

      public void setResY(double aResY)
      Sets a spatial resolution along the Y axis of the response coordinate reference system (see setResponseCRS(String)) for the requested coverage.
      Parameters:
      aResY - a spatial resolution along the Y axis of the response CRS for the requested coverage

    • setResZ

      public void setResZ(double aResZ)
      Sets a spatial resolution along the Z axis of the response coordinate reference system (see setResponseCRS(String)) for the requested coverage.
      Parameters:
      aResZ - a spatial resolution along the Z axis of the response CRS for the requested coverage

    • setInterpolation

      public void setInterpolation(TLcdWCSInterpolationMethod aInterpolationMethod)
      Sets the interpolation method for resampling coverage values into the desired output grid. This must be one of the values listed in the description of the requested coverage.
      Parameters:
      aInterpolationMethod - the interpolation method for resampling coverage values into the desired output grid.
      Throws:
      NullPointerException - if the interpolation method is null

    • setFormat

      public void setFormat(String aFormat)
      Sets the format that the WCS should use to encode the requested coverage.
      Parameters:
      aFormat - the format that the WCS should use to encode the requested coverage.
      Throws:
      NullPointerException - if the format is null

    • setParameterConstraintValue

      public void setParameterConstraintValue(String aParameterName, String aValue)
      Sets a value-based parameter constraint to request a subset of the specified coverage. The parameter name must match the name of a parameter listed in the range set description of the selected coverage.
      Parameters:
      aParameterName - The name of the parameter constraint
      aValue - The value for the parameter constraint

    • setParameterConstraintInterval

      public void setParameterConstraintInterval(String aParameterName, String aMinimum, String aMaximum)
      Sets an interval-based parameter constraint to request a subset of the specified coverage. The parameter name must match the name of a parameter listed in the range set description of the selected coverage.
      Parameters:
      aParameterName - The name of the parameter constraint
      aMinimum - The minimum value of the interval for the parameter constraint
      aMaximum - The maximum value of the interval for the parameter constraint

    • setParameterConstraintInterval

      public void setParameterConstraintInterval(String aParameterName, String aMinimum, String aMaximum, String aResolution)
      Sets an interval-based parameter constraint to request a subset of the specified coverage. The parameter name must match the name of a parameter listed in the range set description of the selected coverage.
      Parameters:
      aParameterName - The name of the parameter constraint
      aMinimum - The minimum value of the interval for the parameter constraint
      aMaximum - The maximum value of the interval for the parameter constraint
      aResolution - The resolution of the value interval for the parameter constraint

    • getKVPEncoding

      public Map getKVPEncoding()
      Returns a key-value pair (KVP) encoding of this request.

      If no key-value pairs are defined, an empty map should be returned. If no key-value pair encoding is supported for this request, null should be returned.

      Specified by:
      getKVPEncoding in interface ILcdOWSRequest
      Returns:
      the key-value pair (KVP) representation of this request.

    • getXMLEncoding

      public InputStream getXMLEncoding()
      Returns null. XML encoding is not supported.
      Specified by:
      getXMLEncoding in interface ILcdOWSRequest
      Returns:
      null

    • getRestEncoding

      public URI getRestEncoding(URI aBaseURI)
      Returns null, REST encoding is not supported.
      Specified by:
      getRestEncoding in interface ILcdOWSRequest
      Parameters:
      aBaseURI - the base URI to be used to construct the REST encoding
      Returns:
      null
      Since:
      2013.0