com.luciad.multidimensional

LuciadLightspeedInterface ILcdDimension<T>

All Known Implementing Classes:

TLcdDimension

public interface ILcdDimension<T>

This interface defines the possible values or intervals in which data is defined. It contains an axis in which a list of possible values is defined. For convenience, this interface also contains a getUnionValues method that represents the union of all values.

Data can for example be present at a number of specific times or time intervals. In that case the axis can have a Date type. The ranges can then consist of a number of TLcdDimensionInterval<Date> instances.

Since:

2015.0

Method Summary

Modifier and Type	Method and Description
TLcdDimensionAxis<T>	getAxis() Returns the axis in which the possible values are defined.
TLcdDimensionInterval<T>	getUnionOfValues() Returns the union of the ranges in which data can be available.
List<TLcdDimensionInterval<T>>	getValues() Returns the intervals in which data can be available for this axis.

Method Detail

getAxis

TLcdDimensionAxis<T> getAxis()

Returns the axis in which the possible values are defined.

Returns:

the axis in which the possible values are defined.

getUnionOfValues

TLcdDimensionInterval<T> getUnionOfValues()

Returns the union of the ranges in which data can be available. The returned object is a union of the intervals returned by getValues.

Returns:

the union of the values of this axis in which data can be available, possibly empty or the unbounded interval but never null.

getValues

List<TLcdDimensionInterval<T>> getValues()

Returns the intervals in which data can be available for this axis. The list of intervals is finite, is sorted, and contains no duplicates according to TLcdDimensionInterval.equals(). The list may contain overlapping intervals though.

Models offering logically infinite intervals such as "every week day on Monday" will have to limit the intervals they offer to a practical finite collection.

Returns:

the intervals in which data can be available for this axis, possibly empty but never null.