Package com.luciad.wms.server.model

Class ALcdWMSDimension

java.lang.Object
com.luciad.wms.server.model.ALcdWMSDimension
Direct Known Subclasses:
TLcdWMSDimension
public abstract class ALcdWMSDimension extends Object
Represents a dimensional parameter for a layer or a group of layers.

This class is a direct representation of the dimension concept introduced in the OGC WMS specification. A WMS dimension is used to parametrize a layer according to a certain dimension. Clients can then request a layer for a given dimension value. Common dimension examples are time and elevation, to respectively represent time-dependent and altitude-dependent data.

A dimension is identified by a name. The properties units and unit symbol describe the unit in which the dimension is represented (e.g. seconds or feet). The values that a client can use for the dimension are described by the extent property. The extent can be either a continuous value interval or a set of discrete values (or a combination).

  • Constructor Summary

    Constructors
    Constructor
    Description
    ALcdWMSDimension()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract TLcdWMSDimensionExtent
    getDefaultValue()
    Returns the default value that will be used if a GetMap request does not specify a value.
    abstract TLcdWMSDimensionExtent
    getExtent()
    Returns the extent of this dimensional parameter.
    abstract String
    getName()
    Returns the name of the dimensional parameter.
    abstract String
    getUnits()
    Returns the units of the dimensional parameter.
    abstract String
    getUnitSymbol()
    Returns the unit symbol of the dimensional parameter.
    abstract boolean
    isCurrent()
    This property is only valid for temporal extents (e.g. time), and indicates whether (a) temporal data are normally kept current and (b) whether the request parameter TIME may include the keyword 'current' instead of an ending value.
    abstract boolean
    isMultipleValues()
    Returns whether multiple values of the dimensional parameter may be requested.
    abstract boolean
    isNearestValue()
    Returns whether the nearest value of the dimensional parameter will be returned in response to a request for a nearby value.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ALcdWMSDimension

      public ALcdWMSDimension()

  • Method Details

    • getName

      public abstract String getName()
      Returns the name of the dimensional parameter.
      Returns:
      the name of the dimensional parameter.

    • getUnits

      public abstract String getUnits()
      Returns the units of the dimensional parameter.
      Returns:
      the units of the dimensional parameter.

    • getUnitSymbol

      public abstract String getUnitSymbol()
      Returns the unit symbol of the dimensional parameter.
      Returns:
      the unit symbol of the dimensional parameter.

    • getDefaultValue

      public abstract TLcdWMSDimensionExtent getDefaultValue()
      Returns the default value that will be used if a GetMap request does not specify a value. If not specified, a service exception will be sent to the client if the request does not include a value for that dimension.
      Returns:
      the default value that will be used if a GetMap request does not specify a value.

    • getExtent

      public abstract TLcdWMSDimensionExtent getExtent()
      Returns the extent of this dimensional parameter. The extent defines the possible values/intervals
      Returns:
      the extent of this dimensional parameter.

    • isMultipleValues

      public abstract boolean isMultipleValues()
      Returns whether multiple values of the dimensional parameter may be requested.
      Returns:
      whether multiple values of the dimensional parameter may be requested.

    • isNearestValue

      public abstract boolean isNearestValue()
      Returns whether the nearest value of the dimensional parameter will be returned in response to a request for a nearby value.
      Returns:
      whether the nearest value of the dimensional parameter will be returned in response to a request for a nearby value.

    • isCurrent

      public abstract boolean isCurrent()
      This property is only valid for temporal extents (e.g. time), and indicates whether (a) temporal data are normally kept current and (b) whether the request parameter TIME may include the keyword 'current' instead of an ending value.
      Returns:
      Returns whether (a) temporal data are normally kept current and (b) whether the request parameter TIME may include the keyword 'current' instead of an ending value.