Class Column.Builder

    • Method Detail

      • set

        public Column.Builder set​(java.lang.String propertyName,
                                  java.lang.Object newValue)
      • build

        public Column build()
      • name

        public Column.Builder name​(ColumnName name)
        Sets the column name.

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

        Parameters:
        name - the new value, not null
        Returns:
        this, for chaining, not null
      • measure

        public Column.Builder measure​(Measure measure)
        Sets the measure to be calculated.

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

        Parameters:
        measure - the new value, not null
        Returns:
        this, for chaining, not null
      • reportingCurrency

        public Column.Builder reportingCurrency​(ReportingCurrency reportingCurrency)
        Sets the reporting currency, used to control currency conversion, optional.

        This is used to specify the currency that the result should be reporting in. If the result is not associated with a currency, such as for "par rate", then the reporting currency will effectively be ignored.

        If empty, the reporting currency from CalculationRules will be used.

        Parameters:
        reportingCurrency - the new value
        Returns:
        this, for chaining, not null
      • parameters

        public Column.Builder parameters​(CalculationParameters parameters)
        Sets the calculation parameters that apply to this column, used to control the how the calculation is performed.

        The parameters from CalculationRules and Column are combined. If a parameter is defined here and in the rules with the same query type, then the column parameter takes precedence.

        When building, these will default to be empty.

        Parameters:
        parameters - the new value
        Returns:
        this, for chaining, not null