Package net.pricefx.common.apibuilder.chart

Class Formula<S extends AbstractChartSeries<?,S>>

Object
ObjectIdentity
BacklinkBuilder<S>
Formula<S>
Type Parameters:
S - the type of the series this logic is attached to
public class Formula<S extends AbstractChartSeries<?,S>> extends BacklinkBuilder<S>
Builder for attaching an Analytics Calculation Logic (created under Administration > Logics > Calculation Logic > Analytics) to a series, obtained from AbstractChartSeries.setFormula() rather than instantiated directly.

The logic runs when the series is evaluated and enriches its data. On a Data Table its row-level output can add extra columns to the series; on a chart only the logic's Summary-level output is consumed, to supply auxiliary line values (Y intercept, X intercept, and steepness). It does not replace the series' plotted values, and auxiliary lines are not available on pie or waterfall charts.

See Also:

  • Field Summary

    Fields inherited from class BacklinkBuilder

    METHOD_BACK

    Fields inherited from class ObjectIdentity

    classId, idGenerator, instanceId, invocations, m, NONE, parentObjectIdentity

  • Constructor Summary

    Constructors
    Constructor
    Description
    Formula(S backLink, String instanceId, String classId)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Formula<S>
    addInputParameter(String inputParamName, String value)
    Supplies a textual value for one of the Calculation Logic's input parameters.
    Formula<S>
    addInputParameter(String inputParamName, BigDecimal value)
    Supplies a numeric value for one of the Calculation Logic's input parameters.
    Formula<S>
    setFormulaName(String formulaName)
    Sets the unique name of the Analytics Calculation Logic to run for this series.
    Formula<S>
    setTargetDate(Date date)
    Sets the date the Calculation Logic is evaluated as of, for a logic whose result depends on an effective date.

    Methods inherited from class BacklinkBuilder

    back, getParent

    Methods inherited from class ObjectIdentity

    addInvocation, addInvocation, addInvocationInternal, getClassId

    Methods inherited from class Object

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

  • Constructor Details

    • Formula

      public Formula(S backLink, String instanceId, String classId)

  • Method Details

    • setFormulaName

      public Formula<S> setFormulaName(String formulaName)
      Sets the unique name of the Analytics Calculation Logic to run for this series.
      Parameters:
      formulaName - the unique name of the Calculation Logic
      Returns:
      this Formula builder, for chaining further configuration

    • setTargetDate

      public Formula<S> setTargetDate(Date date)
      Sets the date the Calculation Logic is evaluated as of, for a logic whose result depends on an effective date.
      Parameters:
      date - the date to evaluate the Calculation Logic as of
      Returns:
      this Formula builder, for chaining further configuration

    • addInputParameter

      public Formula<S> addInputParameter(String inputParamName, BigDecimal value)
      Supplies a numeric value for one of the Calculation Logic's input parameters.
      Parameters:
      inputParamName - the name of the Calculation Logic input parameter to supply
      value - the numeric value to supply for the parameter
      Returns:
      this Formula builder, for chaining further configuration
      See Also:

    • addInputParameter

      public Formula<S> addInputParameter(String inputParamName, String value)
      Supplies a textual value for one of the Calculation Logic's input parameters.
      Parameters:
      inputParamName - the name of the Calculation Logic input parameter to supply
      value - the textual value to supply for the parameter
      Returns:
      this Formula builder, for chaining further configuration
      See Also: