org.gvsig.raster.wms.io.time

Class DefaultDimension

java.lang.Object

org.gvsig.raster.wms.io.time.DefaultDimension

All Implemented Interfaces:

RemoteTimeDimension, Persistent

public class DefaultDimension
extends Object
implements RemoteTimeDimension

This class instances a regular WMS dimension. It handles single, multiple and interval values and uses them as they were a point, a list or a regularly split line, respectivelly.

As far as it implements RemoteTimeDimension it uses the same interface and documentation.

Field Summary

Fields inherited from interface org.gvsig.raster.wms.io.time.RemoteTimeDimension

INTERVAL, MULTIPLE_VALUE, SINGLE_VALUE

Constructor Summary

Constructors

Constructor and Description
DefaultDimension()
DefaultDimension(String _name, String _units, String _unitSymbol, String _dimensionExpression) Creates a new instance of DefaultDimension.

Method Summary

Methods

Modifier and Type	Method and Description
void	compile() Analyzes and establishes the starting values for this dimension.
String	getExpression() Returns the expression describing this WMS Dimension
String	getHighLimit() This method returns the highest value of this dimension if this dimension is specified as an interval or as a set of values, or the value specified if it was a single value.
String	getLowLimit() This method returns the lowest value of this dimension if this dimension is specified as an interval or as a set of values, or the value specified if it was a single value.
String	getName() Return the dimension's name.
String	getResolution() This method returns the resolution supported by this dimension.
int	getType() Returns the type of the dimension expression.
String	getUnit() Return the unit used by this dimension.
String	getUnitSymbol() Returns the unit symbol (i.e.
boolean	isValidValue(String value) Checks if the value represented as string is a valid value by checking if the dimensions supports it.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
static void	registerPersistent()
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setExpression(String expr) Sets the expression describing this WMS Dimension
String	valueAt(int pos) Returns the value that would be at the position passed as argument.
int	valueCount() The amount of positions that this dimension contains.
Object	valueOf(String value) Return the value of the String passed in the dimension's unit-natural type.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDimension

public DefaultDimension()

DefaultDimension

public DefaultDimension(String _name,
                String _units,
                String _unitSymbol,
                String _dimensionExpression)

Creates a new instance of DefaultDimension.

Parameters:

_name -

_units -

_unitSymbol -

_dimensionExpression -

Method Detail

loadFromState

public void loadFromState(PersistentState state)
                   throws PersistenceException

Description copied from interface: Persistent

Set the state of the object from the state passed as parameter.

Specified by:

loadFromState in interface Persistent

Throws:

PersistenceException

saveToState

public void saveToState(PersistentState state)
                 throws PersistenceException

Description copied from interface: Persistent

Saves the internal state of the object on the provided PersistentState object.

Specified by:

saveToState in interface Persistent

Throws:

PersistenceException

registerPersistent

public static void registerPersistent()

getName

public String getName()

Description copied from interface: RemoteTimeDimension

Return the dimension's name. This value is the value that will be used in a GetMap request.

Specified by:

getName in interface RemoteTimeDimension

Returns:

String containing the name of this dimension.

getUnit

public String getUnit()

Description copied from interface: RemoteTimeDimension

Return the unit used by this dimension.

Specified by:

getUnit in interface RemoteTimeDimension

Returns:

getUnitSymbol

public String getUnitSymbol()

Description copied from interface: RemoteTimeDimension

Returns the unit symbol (i.e. 'm', 's', or 'l' for meters, seconds, or liters respectively)

Specified by:

getUnitSymbol in interface RemoteTimeDimension

Returns:

getLowLimit

public String getLowLimit()

Description copied from interface: RemoteTimeDimension

This method returns the lowest value of this dimension if this dimension is specified as an interval or as a set of values, or the value specified if it was a single value.

Specified by:

getLowLimit in interface RemoteTimeDimension

Returns:

String containing the coded value.

getHighLimit

public String getHighLimit()

Description copied from interface: RemoteTimeDimension

This method returns the highest value of this dimension if this dimension is specified as an interval or as a set of values, or the value specified if it was a single value.

Specified by:

getHighLimit in interface RemoteTimeDimension

Returns:

String containing the coded value.

getResolution

public String getResolution()

Description copied from interface: RemoteTimeDimension

This method returns the resolution supported by this dimension. This means the step lenght between two consecutive points along the dimension's axis.

Specified by:

getResolution in interface RemoteTimeDimension

Returns:

String containing the coded value, or null if no value for resolution.

isValidValue

public boolean isValidValue(String value)

Description copied from interface: RemoteTimeDimension

Checks if the value represented as string is a valid value by checking if the dimensions supports it. It should be true if one of the following is true:

1. The dimension supports nearest values and the value is greather or equal than the low limit and less or equal than the high limit.
2. The value matches in one of the points defined by the low and high limits, and the resolution value.

Specified by:

isValidValue in interface RemoteTimeDimension

Returns:

valueOf

public Object valueOf(String value)
               throws IllegalArgumentException

Description copied from interface: RemoteTimeDimension

Return the value of the String passed in the dimension's unit-natural type.

Specified by:

valueOf in interface RemoteTimeDimension

Returns:

Throws:

IllegalArgumentException

valueAt

public String valueAt(int pos)
               throws ArrayIndexOutOfBoundsException

Description copied from interface: RemoteTimeDimension

Returns the value that would be at the position passed as argument.

Specified by:

valueAt in interface RemoteTimeDimension

Returns:

Throws:

ArrayIndexOutOfBoundsException

valueCount

public int valueCount()

Description copied from interface: RemoteTimeDimension

The amount of positions that this dimension contains.

Specified by:

valueCount in interface RemoteTimeDimension

Returns:

-1 if the dimension is not recognized, the amount otherwise

getExpression

public String getExpression()

Description copied from interface: RemoteTimeDimension

Returns the expression describing this WMS Dimension

Specified by:

getExpression in interface RemoteTimeDimension

setExpression

public void setExpression(String expr)

Description copied from interface: RemoteTimeDimension

Sets the expression describing this WMS Dimension

Specified by:

setExpression in interface RemoteTimeDimension

getType

public int getType()

Description copied from interface: RemoteTimeDimension

Returns the type of the dimension expression.
Possible values are:

1. IFMapWMSDimension.SINGLE_VALUE IFMapWMSDimension.MULTIPLE_VALUE IFMapWMSDimension.INTERVAL

Specified by:

getType in interface RemoteTimeDimension

Returns:

int

compile

public void compile()
             throws IllegalArgumentException

Description copied from interface: RemoteTimeDimension

Analyzes and establishes the starting values for this dimension. No operation of this dimension can be called before the dimension has been compiled.

Specified by:

compile in interface RemoteTimeDimension

Throws:

IllegalArgumentException