org.gvsig.raster.wms.io.time

Interface RemoteTimeDimension

All Superinterfaces:

Persistent

All Known Implementing Classes:

DefaultDimension, TimeDimension

public interface RemoteTimeDimension
extends Persistent

Field Summary

Fields

Modifier and Type	Field and Description
static int	INTERVAL
static int	MULTIPLE_VALUE
static int	SINGLE_VALUE

Method Summary

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() Deprecated.
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	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 interface org.gvsig.tools.persistence.Persistent

loadFromState, saveToState

Field Detail

SINGLE_VALUE

static final int SINGLE_VALUE

See Also:

Constant Field Values

MULTIPLE_VALUE

static final int MULTIPLE_VALUE

See Also:

Constant Field Values

INTERVAL

static final int INTERVAL

See Also:

Constant Field Values

Method Detail

getName

String getName()

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

Returns:

String containing the name of this dimension.

getUnit

String getUnit()

Return the unit used by this dimension.

Returns:

getUnitSymbol

String getUnitSymbol()

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

Returns:

getLowLimit

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.

Returns:

String containing the coded value.

getHighLimit

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.

Returns:

String containing the coded value.

getResolution

String getResolution()

Deprecated.

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

Returns:

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

isValidValue

boolean isValidValue(String value)

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.

Parameters:

value -

Returns:

valueOf

Object valueOf(String value)
        throws IllegalArgumentException

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

Parameters:

value -

Returns:

Throws:

IllegalArgumentException

valueAt

String valueAt(int pos)
        throws ArrayIndexOutOfBoundsException

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

Parameters:

pos -

Returns:

Throws:

ArrayIndexOutOfBoundsException

valueCount

int valueCount()

The amount of positions that this dimension contains.

Returns:

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

getExpression

String getExpression()

Returns the expression describing this WMS Dimension

setExpression

void setExpression(String expr)

Sets the expression describing this WMS Dimension

Throws:

IllegalArgumentException

getType

int getType()

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

1. IFMapWMSDimension.SINGLE_VALUE IFMapWMSDimension.MULTIPLE_VALUE IFMapWMSDimension.INTERVAL

Returns:

int

compile

void compile()
      throws IllegalArgumentException

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

Throws:

IllegalArgumentException