com.luciad.multidimensional

LuciadLightspeedClass TLcdDimensionAxis.Builder<T>

java.lang.Object

com.luciad.multidimensional.TLcdDimensionAxis.Builder<T>

Enclosing class:

TLcdDimensionAxis<T>

public static final class TLcdDimensionAxis.Builder<T>
extends Object

Builder for dimension axes.

Since:

2015.0

Method Summary

Modifier and Type	Method and Description
TLcdDimensionAxis.Builder<T>	all(TLcdDimensionAxis<T> aDimensionAxis) Sets all parameters on the builder based on the given axis.
TLcdDimensionAxis<T>	build() Builds the dimension axis with the set parameters.
TLcdDimensionAxis.Builder<T>	displayName(String aDisplayName) Sets the display name of the dimension axis.
TLcdDimensionAxis.Builder<T>	positive(boolean aPositive) Sets the direction of axis.
TLcdDimensionAxis.Builder<T>	type(Class<T> aType)
TLcdDimensionAxis.Builder<T>	unit(ILcdISO19103UnitOfMeasure aUnit) Sets the unit of this axis.

Methods inherited from class java.lang.Object

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

Method Detail

type

public TLcdDimensionAxis.Builder<T> type(Class<T> aType)

displayName

public TLcdDimensionAxis.Builder<T> displayName(String aDisplayName)

Sets the display name of the dimension axis. If no display name is set, a default display name is set.

Parameters:

aDisplayName - the display name

Returns:

this

unit

public TLcdDimensionAxis.Builder<T> unit(ILcdISO19103UnitOfMeasure aUnit)

Sets the unit of this axis. Calling this method is optional but recommended. See getUnit for more information.

Parameters:

aUnit - the unit of this axis (optional)

Returns:

this

positive

public TLcdDimensionAxis.Builder<T> positive(boolean aPositive)

Sets the direction of axis. Default value is true which indicates that this axis is increasing (height, alt.) If false is provided, it means that this axis is decreasing (depth etc.)

Parameters:

aPositive - axis increasing/decreasing

Returns:

this

all

public TLcdDimensionAxis.Builder<T> all(TLcdDimensionAxis<T> aDimensionAxis)

Sets all parameters on the builder based on the given axis.

This is useful for example to create a new axis that has almost all properties equal to another axis.

Parameters:

aDimensionAxis - the axis to copy

Returns:

this

build

public TLcdDimensionAxis<T> build()

Builds the dimension axis with the set parameters.

Returns:

the created dimension axis.