com.luciad.wms.server.model

OGC ServerClass TLcdWMSDimension

java.lang.Object

com.luciad.wms.server.model.ALcdWMSDimension

com.luciad.wms.server.model.TLcdWMSDimension

public class TLcdWMSDimension
extends ALcdWMSDimension

Default implementation of ALcdWMSDimension.

Constructor Summary

Constructors

Constructor and Description
TLcdWMSDimension()

Method Summary

Modifier and Type	Method and Description
TLcdWMSDimensionExtent	getDefaultValue() Returns the default value that will be used if a GetMap request does not specify a value.
TLcdWMSDimensionExtent	getExtent() Returns the extent of this dimensional parameter.
String	getName() Returns the name of the dimensional parameter.
String	getUnits() Returns the units of the dimensional parameter.
String	getUnitSymbol() Returns the unit symbol of the dimensional parameter.
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.
boolean	isMultipleValues() Returns whether multiple values of the dimensional parameter may be requested.
boolean	isNearestValue() Returns whether the nearest value of the dimensional parameter will be returned in response to a request for a nearby value.
void	setCurrent(boolean aCurrent) This property is only valid for temporal extents (for example, 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.
void	setDefaultValue(TLcdWMSDimensionExtent aDefaultValue) Sets the default value to be used when a GetMap request does not specify a value.
void	setExtent(TLcdWMSDimensionExtent aExtent) Sets the extent, which consists of the possible values/intervals for this dimensional parameter.
void	setMultipleValues(boolean aMultipleValues) Sets whether multiple values may be requested.
void	setName(String aName) Sets the name of this dimensional parameter.
void	setNearestValue(boolean aNearestValue) Sets whether the nearest value of the dimensional parameter will be returned in response to a request for a nearby value.
void	setUnits(String aUnits) Sets the units of this dimensional parameter.
void	setUnitSymbol(String aUnitSymbol) Sets the unit symbol of this dimensional parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdWMSDimension

public TLcdWMSDimension()

Method Detail

getName

public String getName()

Description copied from class: ALcdWMSDimension

Returns the name of the dimensional parameter.

Specified by:

getName in class ALcdWMSDimension

Returns:

the name of the dimensional parameter.

setName

public void setName(String aName)

Sets the name of this dimensional parameter.

Parameters:

aName - the name of this dimensional parameter.

getUnits

public String getUnits()

Description copied from class: ALcdWMSDimension

Returns the units of the dimensional parameter.

Specified by:

getUnits in class ALcdWMSDimension

Returns:

the units of the dimensional parameter.

setUnits

public void setUnits(String aUnits)

Sets the units of this dimensional parameter.

Parameters:

aUnits - the units of this dimensional parameter.

getUnitSymbol

public String getUnitSymbol()

Description copied from class: ALcdWMSDimension

Returns the unit symbol of the dimensional parameter.

Specified by:

getUnitSymbol in class ALcdWMSDimension

Returns:

the unit symbol of the dimensional parameter.

setUnitSymbol

public void setUnitSymbol(String aUnitSymbol)

Sets the unit symbol of this dimensional parameter.

Parameters:

aUnitSymbol - the unit symbol of this dimensional parameter.

getDefaultValue

public TLcdWMSDimensionExtent getDefaultValue()

Description copied from class: ALcdWMSDimension

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.

Specified by:

getDefaultValue in class ALcdWMSDimension

Returns:

the default value that will be used if a GetMap request does not specify a value.

setDefaultValue

public void setDefaultValue(TLcdWMSDimensionExtent aDefaultValue)

Sets the default value to be used when a GetMap request does not specify a value.

Parameters:

aDefaultValue - the default value to be used when a GetMap request does not specify a value.

getExtent

public TLcdWMSDimensionExtent getExtent()

Description copied from class: ALcdWMSDimension

Returns the extent of this dimensional parameter. The extent defines the possible values/intervals

Specified by:

getExtent in class ALcdWMSDimension

Returns:

the extent of this dimensional parameter.

setExtent

public void setExtent(TLcdWMSDimensionExtent aExtent)

Sets the extent, which consists of the possible values/intervals for this dimensional parameter.

Parameters:

aExtent - The extent for this dimensional parameter.

isMultipleValues

public boolean isMultipleValues()

Description copied from class: ALcdWMSDimension

Returns whether multiple values of the dimensional parameter may be requested.

Specified by:

isMultipleValues in class ALcdWMSDimension

Returns:

whether multiple values of the dimensional parameter may be requested.

setMultipleValues

public void setMultipleValues(boolean aMultipleValues)

Sets whether multiple values may be requested.

Parameters:

aMultipleValues - whether multiple values may be requested.

isNearestValue

public boolean isNearestValue()

Description copied from class: ALcdWMSDimension

Returns whether the nearest value of the dimensional parameter will be returned in response to a request for a nearby value.

Specified by:

isNearestValue in class ALcdWMSDimension

Returns:

whether the nearest value of the dimensional parameter will be returned in response to a request for a nearby value.

setNearestValue

public void setNearestValue(boolean aNearestValue)

Sets whether the nearest value of the dimensional parameter will be returned in response to a request for a nearby value.

Parameters:

aNearestValue - whether the nearest value of the dimensional parameter will be returned in response to a request for a nearby value.

isCurrent

public boolean isCurrent()

Description copied from class: ALcdWMSDimension

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.

Specified by:

isCurrent in class ALcdWMSDimension

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.

setCurrent

public void setCurrent(boolean aCurrent)

This property is only valid for temporal extents (for example, 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.

Parameters:

aCurrent - 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.