com.luciad.wms.client.model

LuciadLightspeedClass TLcdOGCWMSDimensionExtent

java.lang.Object

com.luciad.wms.client.model.TLcdOGCWMSDimensionExtent

public final class TLcdOGCWMSDimensionExtent
extends Object

A dimension extent represents the set of values or intervals that are available for a dimensional parameter.

See Also:

ALcdOGCWMSDimension

Constructor Summary

Constructors

Constructor and Description
TLcdOGCWMSDimensionExtent()

Method Summary

Modifier and Type	Method and Description
void	addInterval(String[] aInterval) Adds the specified interval to this dimensional parameter.
void	addValue(String aValue) Adds the specified value to this dimensional parameter.
boolean	canAddInterval(String[] aInterval) Returns whether the specified interval can be added to this dimension parameter.
boolean	canAddValue(String aValue) Returns whether the specified value can be added to this dimensional parameter.
String[]	getInterval(int aIndex) Returns the interval at the specified index.
int	getIntervalCount() Returns the number of available intervals for the dimensional parameter.
String	getValue(int aIndex) Returns the value at the specified index.
int	getValueCount() Returns the number of available values for the dimensional parameter.
void	removeInterval(int aIndex) Removes the interval at the specified index.
void	removeValue(int aIndex) Removes the value at the specified index.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdOGCWMSDimensionExtent

public TLcdOGCWMSDimensionExtent()

Method Detail

getValue

public String getValue(int aIndex)

Returns the value at the specified index.

Parameters:

aIndex - The index of the value to be retrieved.

Returns:

the value at the specified index.

getValueCount

public int getValueCount()

Returns the number of available values for the dimensional parameter.

Returns:

the number of available values for the dimensional parameter.

canAddValue

public boolean canAddValue(String aValue)

Returns whether the specified value can be added to this dimensional parameter. If no intervals have been added yet and the value is not null, true is returned. In all other cases, false is returned.

Parameters:

aValue - A value.

Returns:

true if no intervals have been added yet, false otherwise.

addValue

public void addValue(String aValue)

Adds the specified value to this dimensional parameter.

Parameters:

aValue - the value to be added.

Throws:

IllegalStateException - if canAddValue(String) returns false.

removeValue

public void removeValue(int aIndex)

Removes the value at the specified index.

Parameters:

aIndex - The index of the value to be removed.

getInterval

public String[] getInterval(int aIndex)

Returns the interval at the specified index.

Parameters:

aIndex - The index of the interval to be retrieved.

Returns:

the interval at the specified index.

getIntervalCount

public int getIntervalCount()

Returns the number of available intervals for the dimensional parameter.

Returns:

the number of available intervals for the dimensional parameter.

canAddInterval

public boolean canAddInterval(String[] aInterval)

Returns whether the specified interval can be added to this dimension parameter. If no values have been added yet and if the interval is valid, true is returned. An interval is considered valid when it has length 3 and does not contain any null values. In all other cases, false is returned.

Parameters:

aInterval - An interval.

Returns:

true if no values have been added yet and if the interval is valid, false otherwise.

addInterval

public void addInterval(String[] aInterval)

Adds the specified interval to this dimensional parameter.

Parameters:

aInterval - the interval to be added.

Throws:

IllegalStateException - if canAddInterval(String[]) returns false.

removeInterval

public void removeInterval(int aIndex)

Removes the interval at the specified index.

Parameters:

aIndex - The index of the interval to be removed.