com.opengamma.strata.market.cube

Class SimpleCubeParameterMetadata

java.lang.Object

com.opengamma.strata.market.cube.SimpleCubeParameterMetadata

All Implemented Interfaces:

ParameterMetadata, Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class SimpleCubeParameterMetadata
extends Object
implements ParameterMetadata, org.joda.beans.ImmutableBean, Serializable

Simple parameter metadata containing the x, y, z values and type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleCubeParameterMetadata.Meta The meta-bean for SimpleCubeParameterMetadata.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getIdentifier() Returns an object used to identify the parameter.
String	getLabel() Gets the label that describes the parameter.
double	getXValue() Gets the x-value.
ValueType	getXValueType() Gets the type of the x-value.
double	getYValue() Gets the y-value.
ValueType	getYValueType() Gets the type of the y-value.
double	getZValue() Gets the z-value.
ValueType	getZValueType() Gets the type of the z-value.
int	hashCode()
static SimpleCubeParameterMetadata.Meta	meta() The meta-bean for SimpleCubeParameterMetadata.
SimpleCubeParameterMetadata.Meta	metaBean()
static SimpleCubeParameterMetadata	of(ValueType xValueType, double xValue, ValueType yValueType, double yValue, ValueType zValueType, double zValue) Obtains an instance specifying information.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.opengamma.strata.market.param.ParameterMetadata

empty, listOfEmpty

Methods inherited from interface org.joda.beans.Bean

property, propertyNames

Method Detail

of

public static SimpleCubeParameterMetadata of(ValueType xValueType,
                                             double xValue,
                                             ValueType yValueType,
                                             double yValue,
                                             ValueType zValueType,
                                             double zValue)

Obtains an instance specifying information.

Parameters:

xValueType - the x-value type

xValue - the x-value

yValueType - the x-value type

yValue - the x-value

zValueType - the z-value type

zValue - the z-value

Returns:

the parameter metadata based on the date and label

getLabel

public String getLabel()

Description copied from interface: ParameterMetadata

Gets the label that describes the parameter.

It is intended that the label is relatively short, however there is no formal restriction.

Specified by:

getLabel in interface ParameterMetadata

Returns:

the label

getIdentifier

public String getIdentifier()

Description copied from interface: ParameterMetadata

Returns an object used to identify the parameter.

A good choice of identifier is one that makes sense to the user and can easily be created as part of a scenario definition. For example, many nodes types are naturally identified by a tenor.

The identifier must satisfy the following criteria:

• It must be non-null
• It should be unique within a single data set
• It should have a sensible implementation of hashCode() and equals().

Otherwise the choice of identifier is free and the system makes no assumptions about it.

Specified by:

getIdentifier in interface ParameterMetadata

Returns:

an object used to uniquely identify the parameter within the data

meta

public static SimpleCubeParameterMetadata.Meta meta()

The meta-bean for SimpleCubeParameterMetadata.

Returns:

the meta-bean, not null

metaBean

public SimpleCubeParameterMetadata.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getXValueType

public ValueType getXValueType()

Gets the type of the x-value.

Returns:

the value of the property, not null

getXValue

public double getXValue()

Gets the x-value.

Returns:

the value of the property

getYValueType

public ValueType getYValueType()

Gets the type of the y-value.

Returns:

the value of the property, not null

getYValue

public double getYValue()

Gets the y-value.

Returns:

the value of the property

getZValueType

public ValueType getZValueType()

Gets the type of the z-value.

Returns:

the value of the property, not null

getZValue

public double getZValue()

Gets the z-value.

Returns:

the value of the property

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object