Package org.geotools.ows.wms.xml

Class Dimension

Object

Dimension

public class Dimension
extends Object

Property class for holding and handling of property values declared in Dimension-element of a layer. In WMS 1.3.0 this is expanded to include Extent information documenting the valid data values for this range.

http://schemas.opengis.net/wms/1.1.1/WMS_MS_Capabilities.dtd:

 <!-- The Dimension element declares the _existence_ of a dimension. -->
 <!ELEMENT Dimension EMPTY >
 <!ATTLIST Dimension
           name CDATA #REQUIRED
           units CDATA #REQUIRED
           unitSymbol CDATA #IMPLIED>
 

http://schemas.opengis.net/wms/1.3.0/capabilities_1_3_0.xsd:

 <element name="Dimension">
   <complexType>
     <simpleContent>
       <extension base="string">
         <attribute name="name" type="string" use="required"/>
         <attribute name="units" type="string" use="required"/>
         <attribute name="unitSymbol" type="string"/>
         <attribute name="default" type="string"/>
         <attribute name="multipleValues" type="boolean"/>
         <attribute name="nearestValue" type="boolean"/>
         <attribute name="current" type="boolean"/>
       </extension>
     </simpleContent>
   </complexType>
 </element>
 

According to OpenGIS Web Map Service WMS Implementation Specification - C.2 Declaring dimensions and their allowed value (page 52), the 'units' attribute must not be missing, but its value is allowed to be empty:

If the dimensional quantity has no units (e.g. band number in a multi-wavelength sensor), use the null string: units="".

Author:

Per Engstrom, Curalia AB, pereng@gmail.com

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	current
protected Extent	extent	Optional Extent as supplied by WMS 1.3.0
protected String	name	This name is often used as a lookup key
protected String	units	Must not be missing, but can be empty according to WMS spec 1.3, page 52
protected String	unitSymbol

Constructor Summary

Constructors

Constructor	Description
Dimension(String name, String units)
Dimension(String name, String units, String unitSymbol)

Method Summary

Modifier and Type	Method	Description
Extent	getExtent()
String	getName()
String	getUnits()
String	getUnitSymbol()
boolean	isCurrent()
void	setCurrent(boolean current)
void	setExtent(Extent extent)
void	setName(String name)
void	setUnits(String units)
void	setUnitSymbol(String unitSymbol)
String	toString()

Methods inherited from class Object

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

Field Detail

name

protected String name

This name is often used as a lookup key

units

protected String units

Must not be missing, but can be empty according to WMS spec 1.3, page 52

unitSymbol

protected String unitSymbol

current

protected boolean current

extent

protected Extent extent

Optional Extent as supplied by WMS 1.3.0

Constructor Detail

Dimension

public Dimension(String name,
                 String units,
                 String unitSymbol)

Dimension

public Dimension(String name,
                 String units)

Method Detail

getName

public String getName()

setName

public void setName(String name)

getUnits

public String getUnits()

setUnits

public void setUnits(String units)

getUnitSymbol

public String getUnitSymbol()

setUnitSymbol

public void setUnitSymbol(String unitSymbol)

isCurrent

public boolean isCurrent()

setCurrent

public void setCurrent(boolean current)

getExtent

public Extent getExtent()

setExtent

public void setExtent(Extent extent)

toString

public String toString()

Overrides:

toString in class Object