Class SimpleSurfaceParameterMetadata

  • All Implemented Interfaces:
    ParameterMetadata, java.io.Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean

    public final class SimpleSurfaceParameterMetadata
    extends java.lang.Object
    implements ParameterMetadata, org.joda.beans.ImmutableBean, java.io.Serializable
    Simple parameter metadata containing the x and y values and type.
    See Also:
    Serialized Form
    • Method Detail

      • of

        public static SimpleSurfaceParameterMetadata of​(ValueType xValueType,
                                                        double xValue,
                                                        ValueType yValueType,
                                                        double yValue)
        Obtains an instance specifying information about the x-value.
        Parameters:
        xValueType - the x-value type
        xValue - the x-value
        yValueType - the x-value type
        yValue - the x-value
        Returns:
        the parameter metadata based on the date and label
      • getLabel

        public java.lang.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 java.lang.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
      • 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
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object