com.luciad.multidimensional

LuciadFusionClass TLcdDimensionAxis<T>

java.lang.Object

com.luciad.multidimensional.TLcdDimensionAxis<T>

public final class TLcdDimensionAxis<T>
extends Object

This class represents a dimension axis. An axis can for example be a time axis or a vertical axis along which data can be present. This class can be created using the builder pattern. See newBuilder() and TLcdDimensionAxis.Builder.

Since:

2015.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TLcdDimensionAxis.Builder<T> Builder for dimension axes.

Field Summary

Fields

Modifier and Type	Field and Description
static TLcdDimensionAxis<Date>	TIME_AXIS Constant for an axis representing absolute times.

Method Summary

Modifier and Type	Method and Description
TLcdDimensionAxis.Builder<T>	asBuilder() Returns the given TLcdDimensionAxis as a builder.
boolean	equals(Object aObject)
String	getDisplayName() Returns a display name for this axis.
Class<T>	getType() Returns the type of values along this axis.
ILcdISO19103UnitOfMeasure	getUnit() Returns the unit of the values along this axis.
int	hashCode()
boolean	isPositive() Returns true if the axis represents measures like height, altitude etc.
static <T> TLcdDimensionAxis.Builder<T>	newBuilder() Returns a new builder using which a TLcdDimensionAxis can be constructed.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TIME_AXIS

public static final TLcdDimensionAxis<Date> TIME_AXIS

Constant for an axis representing absolute times.

It can for example by used by multidimensional models where the information varies with time (realtime models), e.g. a model containing recorded positions of aircrafts.

This axis assumes that the times are expressed as Dates.

Since:

2016.1

Method Detail

getType

public Class<T> getType()

Returns the type of values along this axis. For example, when this axis represents time, its type can be Date.class.

Returns:

the type of values along this axis.

getUnit

public ILcdISO19103UnitOfMeasure getUnit()

Returns the unit of the values along this axis. For example, when this axis represents a distance, this method could return a distance unit. This method can return null. It is however encouraged to return a non-null unit, for example to combine UI elements for different axes with a compatible or equal unit.

Returns:

the unit of the values along this axis. Can be null.

getDisplayName

public String getDisplayName()

Returns a display name for this axis.

Returns:

a display name for this axis.

isPositive

public boolean isPositive()

Returns true if the axis represents measures like height, altitude etc. Returns false if the axis represents measures like depth.

Returns:

true if the axis is increasing (height etc), false otherwise (depth etc.)

newBuilder

public static <T> TLcdDimensionAxis.Builder<T> newBuilder()

Returns a new builder using which a TLcdDimensionAxis can be constructed.

Returns:

a new dimension axis builder.

asBuilder

public TLcdDimensionAxis.Builder<T> asBuilder()

Returns the given TLcdDimensionAxis as a builder. This builder instance can be modify and used to create a new TLcdDimensionAxis.

Returns:

the given TLcdDimensionAxis as a builder.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object aObject)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object