com.opengamma.strata.market.cube

Class DefaultCubeMetadataBuilder

java.lang.Object

com.opengamma.strata.market.cube.DefaultCubeMetadataBuilder

public final class DefaultCubeMetadataBuilder
extends Object

Builder for cube metadata.

This is created using DefaultCubeMetadata.builder().

Method Summary

Modifier and Type	Method and Description
<T> DefaultCubeMetadataBuilder	addInfo(CubeInfoType<T> type, T value) Adds a single piece of additional information.
DefaultCubeMetadata	build() Builds the metadata instance.
DefaultCubeMetadataBuilder	clearParameterMetadata() Clears the parameter-level metadata.
DefaultCubeMetadataBuilder	cubeName(CubeName cubeName) Sets the cube name.
DefaultCubeMetadataBuilder	cubeName(String cubeName) Sets the cube name.
DefaultCubeMetadataBuilder	dayCount(DayCount dayCount) Sets the day count.
DefaultCubeMetadataBuilder	parameterMetadata(List<? extends ParameterMetadata> parameterMetadata) Sets the parameter-level metadata.
DefaultCubeMetadataBuilder	parameterMetadata(ParameterMetadata... parameterMetadata) Sets the parameter-level metadata.
DefaultCubeMetadataBuilder	wValueType(ValueType wValueType) Sets the w-value type, providing meaning to the w-values of the cube.
DefaultCubeMetadataBuilder	xValueType(ValueType xValueType) Sets the x-value type, providing meaning to the x-values of the cube.
DefaultCubeMetadataBuilder	yValueType(ValueType yValueType) Sets the y-value type, providing meaning to the y-values of the cube.
DefaultCubeMetadataBuilder	zValueType(ValueType zValueType) Sets the z-value type, providing meaning to the z-values of the cube.

Methods inherited from class java.lang.Object

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

Method Detail

cubeName

public DefaultCubeMetadataBuilder cubeName(String cubeName)

Sets the cube name.

Parameters:

cubeName - the cube name

Returns:

this, for chaining

cubeName

public DefaultCubeMetadataBuilder cubeName(CubeName cubeName)

Sets the cube name.

Parameters:

cubeName - the cube name

Returns:

this, for chaining

xValueType

public DefaultCubeMetadataBuilder xValueType(ValueType xValueType)

Sets the x-value type, providing meaning to the x-values of the cube.

This type provides meaning to the x-values.

If using the builder, this defaults to ValueType.UNKNOWN.

Parameters:

xValueType - the x-value type

Returns:

this, for chaining

yValueType

public DefaultCubeMetadataBuilder yValueType(ValueType yValueType)

Sets the y-value type, providing meaning to the y-values of the cube.

This type provides meaning to the y-values.

If using the builder, this defaults to ValueType.UNKNOWN.

Parameters:

yValueType - the y-value type

Returns:

this, for chaining

zValueType

public DefaultCubeMetadataBuilder zValueType(ValueType zValueType)

Sets the z-value type, providing meaning to the z-values of the cube.

This type provides meaning to the z-values.

If using the builder, this defaults to ValueType.UNKNOWN.

Parameters:

zValueType - the z-value type

Returns:

this, for chaining

wValueType

public DefaultCubeMetadataBuilder wValueType(ValueType wValueType)

Sets the w-value type, providing meaning to the w-values of the cube.

This type provides meaning to the w-values.

If using the builder, this defaults to ValueType.UNKNOWN.

Parameters:

wValueType - the w-value type

Returns:

this, for chaining

dayCount

public DefaultCubeMetadataBuilder dayCount(DayCount dayCount)

Sets the day count.

This stores the day count in the additional information map using the key CubeInfoType.DAY_COUNT.

This is stored in the additional information map using Map.put semantics, removing the key if the day count is null.

Parameters:

dayCount - the day count, may be null

Returns:

this, for chaining

addInfo

public <T> DefaultCubeMetadataBuilder addInfo(CubeInfoType<T> type,
                                              T value)

Adds a single piece of additional information.

This is stored in the additional information map using Map.put semantics, removing the key if the instance is null.

Type Parameters:

T - the type of the info

Parameters:

type - the type to store under

value - the value to store, may be null

Returns:

this, for chaining

parameterMetadata

public DefaultCubeMetadataBuilder parameterMetadata(List<? extends ParameterMetadata> parameterMetadata)

Sets the parameter-level metadata.

The parameter metadata must match the number of parameters on the cube. This will replace the existing parameter-level metadata.

Parameters:

parameterMetadata - the parameter metadata

Returns:

this, for chaining

parameterMetadata

public DefaultCubeMetadataBuilder parameterMetadata(ParameterMetadata... parameterMetadata)

Sets the parameter-level metadata.

The parameter metadata must match the number of parameters on the cube. This will replace the existing parameter-level metadata.

Parameters:

parameterMetadata - the parameter metadata

Returns:

this, for chaining

clearParameterMetadata

public DefaultCubeMetadataBuilder clearParameterMetadata()

Clears the parameter-level metadata.

The existing parameter-level metadata will be removed.

Returns:

this, for chaining

build

public DefaultCubeMetadata build()

Builds the metadata instance.

Returns:

the instance