Package net.pricefx.common.apibuilder.chart

Class ChartMeasures.Basic<S extends AbstractChartSeries<?,S>,M extends ChartMeasures.Basic<S,M>>

Object

ObjectIdentity

BacklinkBuilder<S>

AbstractChartMeasures<S,M>

Basic<S,M>

Direct Known Subclasses:

BubbleChart.BubbleAdditionalMeasure, ChartMeasures.Type, DataTableChart.DataTableAdditionalMeasure, HeatmapChart.HeatmapAdditionalMeasure, PieChart.PieAdditionalMeasure, ScatterChart.ScatterAdditionalMeasure, TimeSeriesScatterChart.TimeSeriesScatterAdditionalMeasure

Enclosing class:

ChartMeasures

public abstract static class ChartMeasures.Basic<S extends AbstractChartSeries<?,S>,M extends ChartMeasures.Basic<S,M>>
extends AbstractChartMeasures<S,M>

Re-exposes AbstractChartMeasures.withAggregation(String), AbstractChartMeasures.withAggregation(net.pricefx.common.api.chart.AggregationFormula), AbstractChartMeasures.withFormula(), AbstractChartMeasures.withPercent(), AbstractChartMeasures.withPerUnit(), AbstractChartMeasures.withAverage(), and AbstractChartMeasures.withTotal() as public; the tier extended by a concrete additional-measure type that supports none of ChartMeasures.Type's or ChartMeasures.EmbeddedBoxplot's further options, for example ScatterChart.ScatterAdditionalMeasure or PieChart.PieAdditionalMeasure.

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
Basic(S backLink, String instanceId)

Method Summary

Modifier and Type	Method	Description
final M	withAggregation(String aggregationFunction)	Sets the aggregation formula for this additional measure by its raw string name, for cases not covered by the AbstractChartMeasures.withAggregation(AggregationFormula) overload or the AbstractChartMeasures.withPercent()/ AbstractChartMeasures.withPerUnit()/AbstractChartMeasures.withAverage()/AbstractChartMeasures.withTotal() shortcuts.
final M	withAggregation(AggregationFormula aggregationFunction)	Sets the aggregation formula for this additional measure.
final M	withAverage()	Shorthand for withAggregation(AggregationFormula.AVERAGE).
final M	withFormula()	Marks this additional measure as computed from a named Pricing Formula: the value previously set via AbstractChartMeasures.setMeasure(String) is then treated as a Formula name rather than a plain Datamart field name.
final M	withPercent()	Shorthand for withAggregation(AggregationFormula.PERCENT).
final M	withPerUnit()	Shorthand for withAggregation(AggregationFormula.PERUNIT).
final M	withTotal()	Shorthand for summing this additional measure's values (the Data Analyzer's "Sum" aggregation option).

Methods inherited from class AbstractChartMeasures

getThis, setId, setLabel, setMeasure, setOnZAxis, setType, withBoxplotExpression, withBoxplotField, withExpression

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

Basic

public Basic(S backLink,
 String instanceId)

Method Details

withAggregation

public final M withAggregation(String aggregationFunction)

Description copied from class: AbstractChartMeasures

Sets the aggregation formula for this additional measure by its raw string name, for cases not covered by the AbstractChartMeasures.withAggregation(AggregationFormula) overload or the AbstractChartMeasures.withPercent()/ AbstractChartMeasures.withPerUnit()/AbstractChartMeasures.withAverage()/AbstractChartMeasures.withTotal() shortcuts. Declared protected here; a concrete additional-measure type re-exposes it as public via ChartMeasures.Basic (or a subclass of it).

Overrides:

withAggregation in class AbstractChartMeasures<S extends AbstractChartSeries<?,S>,M extends ChartMeasures.Basic<S,M>>

Parameters:

aggregationFunction - String representation of an AggregationFormula constant

Returns:

this additional measure, for chaining further configuration

See Also:

• AbstractChartMeasures.withAggregation(AggregationFormula)

withAggregation

public final M withAggregation(AggregationFormula aggregationFunction)

Description copied from class: AbstractChartMeasures

Sets the aggregation formula for this additional measure. Declared protected here; a concrete additional-measure type re-exposes it as public via ChartMeasures.Basic (or a subclass of it). The AbstractChartMeasures.withPercent(), AbstractChartMeasures.withPerUnit(), AbstractChartMeasures.withAverage(), and AbstractChartMeasures.withTotal() methods are shortcuts for the most common formulas that avoid passing the enum constant directly.

Overrides:

withAggregation in class AbstractChartMeasures<S extends AbstractChartSeries<?,S>,M extends ChartMeasures.Basic<S,M>>

Parameters:

aggregationFunction - the aggregation formula to apply

Returns:

this additional measure, for chaining further configuration

See Also:

• AbstractChartMeasures.withAggregation(String)

withFormula

public final M withFormula()

Description copied from class: AbstractChartMeasures

Marks this additional measure as computed from a named Pricing Formula: the value previously set via AbstractChartMeasures.setMeasure(String) is then treated as a Formula name rather than a plain Datamart field name. Declared protected here; a concrete additional-measure type re-exposes it as public via ChartMeasures.Basic (or a subclass of it).

Overrides:

withFormula in class AbstractChartMeasures<S extends AbstractChartSeries<?,S>,M extends ChartMeasures.Basic<S,M>>

Returns:

this additional measure, for chaining further configuration

See Also:

• AbstractChartMeasures.setMeasure(String)

withPercent

public final M withPercent()

Description copied from class: AbstractChartMeasures

Shorthand for withAggregation(AggregationFormula.PERCENT). Declared protected here; a concrete additional-measure type re-exposes it as public via ChartMeasures.Basic (or a subclass of it).

Overrides:

withPercent in class AbstractChartMeasures<S extends AbstractChartSeries<?,S>,M extends ChartMeasures.Basic<S,M>>

Returns:

this additional measure, for chaining further configuration

withPerUnit

public final M withPerUnit()

Description copied from class: AbstractChartMeasures

Shorthand for withAggregation(AggregationFormula.PERUNIT). Declared protected here; a concrete additional-measure type re-exposes it as public via ChartMeasures.Basic (or a subclass of it).

Overrides:

withPerUnit in class AbstractChartMeasures<S extends AbstractChartSeries<?,S>,M extends ChartMeasures.Basic<S,M>>

Returns:

this additional measure, for chaining further configuration

withAverage

public final M withAverage()

Description copied from class: AbstractChartMeasures

Shorthand for withAggregation(AggregationFormula.AVERAGE). Declared protected here; a concrete additional-measure type re-exposes it as public via ChartMeasures.Basic (or a subclass of it).

Overrides:

withAverage in class AbstractChartMeasures<S extends AbstractChartSeries<?,S>,M extends ChartMeasures.Basic<S,M>>

Returns:

this additional measure, for chaining further configuration

withTotal

public final M withTotal()

Description copied from class: AbstractChartMeasures

Shorthand for summing this additional measure's values (the Data Analyzer's "Sum" aggregation option). Declared protected here; a concrete additional-measure type re-exposes it as public via ChartMeasures.Basic (or a subclass of it).

Overrides:

withTotal in class AbstractChartMeasures<S extends AbstractChartSeries<?,S>,M extends ChartMeasures.Basic<S,M>>

Returns:

this additional measure, for chaining further configuration