net.grinder.statistics

Interface StatisticExpressionFactory

public interface StatisticExpressionFactory

Factory for StatisticExpressions.

Author:

Philip Aston

Method Summary

Methods

Modifier and Type	Method and Description
StatisticExpression	createConstant(double value) Create a constant float expression.
StatisticExpression	createConstant(long value) Create a constant long expression.
StatisticExpression	createDivision(StatisticExpression numerator, StatisticExpression denominator) Create a division.
StatisticExpression	createExpression(String expression) Parse an expression.
ExpressionView	createExpressionView(String displayName, StatisticExpression expression) Creates a new ExpressionView instance.
ExpressionView	createExpressionView(String displayName, String expressionString, boolean showForCompositeStatistics) Creates a new ExpressionView instance.
StatisticExpression	createMinus(StatisticExpression firstOperand, StatisticExpression[] otherOperands) Create a minus expression.
StatisticExpression	createNegation(StatisticExpression operand) Create a negation.
PeakStatisticExpression	createPeak(StatisticsIndexMap.DoubleIndex peakIndex, StatisticExpression monitoredStatistic) Create a peak double statistic.
PeakStatisticExpression	createPeak(StatisticsIndexMap.LongIndex peakIndex, StatisticExpression monitoredStatistic) Create a peak long statistic.
StatisticExpression	createPrimitive(StatisticsIndexMap.DoubleIndex index) Create a primitive double expression.
StatisticExpression	createPrimitive(StatisticsIndexMap.LongIndex index) Create a primitive long expression.
StatisticExpression	createProduct(StatisticExpression[] operands) Create a product.
StatisticExpression	createSquareRoot(StatisticExpression operand) Create a square root.
StatisticExpression	createSum(StatisticExpression[] operands) Create a sum.
String	normaliseExpressionString(String expression) Apply standard formatting to an expression.

Method Detail

normaliseExpressionString

String normaliseExpressionString(String expression)
                                 throws StatisticsException

Apply standard formatting to an expression.

Parameters:

expression - The expression.

Returns:

The formatted expression.

Throws:

StatisticsException - If the expression is invalid.

createExpression

StatisticExpression createExpression(String expression)
                                     throws StatisticsException

Parse an expression.

Parameters:

expression - The expression.

Returns:

The parsed expression.

Throws:

StatisticsException - If the expression is invalid.

createConstant

StatisticExpression createConstant(long value)

Create a constant long expression.

Parameters:

value - The value.

Returns:

The StatisticExpression.

createConstant

StatisticExpression createConstant(double value)

Create a constant float expression.

Parameters:

value - The value.

Returns:

The StatisticExpression.

createPrimitive

StatisticExpression createPrimitive(StatisticsIndexMap.DoubleIndex index)

Create a primitive double expression.

Parameters:

index - The expression index.

Returns:

The StatisticExpression.

createPrimitive

StatisticExpression createPrimitive(StatisticsIndexMap.LongIndex index)

Create a primitive long expression.

Parameters:

index - The expression index.

Returns:

The StatisticExpression.

createSum

StatisticExpression createSum(StatisticExpression[] operands)

Create a sum.

Parameters:

operands - The things to add.

Returns:

The resulting expression.

createNegation

StatisticExpression createNegation(StatisticExpression operand)

Create a negation.

Parameters:

operand - The thing to negate.

Returns:

The resulting expression.

createMinus

StatisticExpression createMinus(StatisticExpression firstOperand,
                              StatisticExpression[] otherOperands)

Create a minus expression. The result is the first argument less the sum of the remaining arguments.

Parameters:

firstOperand - The first argument.

otherOperands - The remaining arguments.

Returns:

The resulting expression.

createProduct

StatisticExpression createProduct(StatisticExpression[] operands)

Create a product.

Parameters:

operands - The things to multiply.

Returns:

The resulting expression.

createDivision

StatisticExpression createDivision(StatisticExpression numerator,
                                 StatisticExpression denominator)

Create a division.

Parameters:

numerator - The numerator.

denominator - The denominator.

Returns:

The resulting expression.

createSquareRoot

StatisticExpression createSquareRoot(StatisticExpression operand)

Create a square root.

Parameters:

operand - The operand.

Returns:

The resulting expression.

createPeak

PeakStatisticExpression createPeak(StatisticsIndexMap.DoubleIndex peakIndex,
                                 StatisticExpression monitoredStatistic)

Create a peak double statistic.

Parameters:

peakIndex - Index of a slot to store peak information in.

monitoredStatistic - Statistic to monitor.

Returns:

The resulting expression.

createPeak

PeakStatisticExpression createPeak(StatisticsIndexMap.LongIndex peakIndex,
                                 StatisticExpression monitoredStatistic)

Create a peak long statistic.

Parameters:

peakIndex - Index of a slot to store peak information in.

monitoredStatistic - Statistic to monitor.

Returns:

The resulting expression.

createExpressionView

ExpressionView createExpressionView(String displayName,
                                  String expressionString,
                                  boolean showForCompositeStatistics)
                                    throws StatisticsException

Creates a new ExpressionView instance.

Parameters:

displayName - A display name. In the console, this is converted to a key for an internationalised resource bundle look up by prefixing the string with "statistic." and replacing any whitespace with underscores.

expressionString - An expression string, used to create the StatisticExpression for the ExpressionView.

showForCompositeStatistics - Whether the expression applies to composite statistics.

Returns:

The ExpressionView.

Throws:

StatisticsException - If the expression is invalid.

createExpressionView

ExpressionView createExpressionView(String displayName,
                                  StatisticExpression expression)

Creates a new ExpressionView instance.

This method takes a StatisticExpression, and is used to by the console to construct a view around expressions that have no string representation (namely, those involving peak statistics).

Parameters:

displayName - A common display name.

expression - A StatisticExpression.

Returns:

The ExpressionView.