Class ColumnHeader

  • All Implemented Interfaces:
    Bean, ImmutableBean

    public final class ColumnHeader
    extends java.lang.Object
    implements ImmutableBean
    Provides access to the column name and measure in the grid of results.

    CalculationRunner provides the ability to calculate a grid of results for a given set targets and columns. This defines the columns in the results.

    • Method Detail

      • of

        public static ColumnHeader of​(ColumnName name,
                                      Measure measure)
        Obtains an instance from the name and measure.
        Parameters:
        name - the name
        measure - the measure
        Returns:
        a column with the specified measure
      • of

        public static ColumnHeader of​(ColumnName name,
                                      Measure measure,
                                      Currency currency)
        Obtains an instance from the name, measure and currency.
        Parameters:
        name - the name
        measure - the measure
        currency - the currency
        Returns:
        a column with the specified measure
      • meta

        public static ColumnHeader.Meta meta()
        The meta-bean for ColumnHeader.
        Returns:
        the meta-bean, not null
      • getName

        public ColumnName getName()
        Gets the column name.

        This is the name of the column, and should be unique in a list of columns.

        Returns:
        the value of the property, not null
      • getMeasure

        public Measure getMeasure()
        Gets the measure that was calculated.

        This defines the calculation that was performed, such as 'PresentValue' or 'ParRate'.

        Returns:
        the value of the property, not null
      • getCurrency

        public java.util.Optional<Currency> getCurrency()
        Gets the currency of the result.

        If the measure can be automatically converted to a different currency, and a specific ReportingCurrency was specified, then the currency will be stored here. If the reporting currency is "natural", or the result has no currency, then this will be empty.

        Returns:
        the optional value of the property, not null
      • 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