net.grinder.statistics

Class ExpressionView

java.lang.Object

net.grinder.statistics.ExpressionView

public final class ExpressionView
extends Object

Associate a statistic expression with display information.

Statistic expressions are composed of statistic names (see StatisticsIndexMap) in a simple post-fix format using the symbols +, -, / and *, which have their usual meanings, in conjunction with simple statistic names or sub-expressions. Precedence can be controlled by grouping expressions in parentheses. For example, the error rate is (* (/ errors period) 1000) errors per second.

Sample statistics, such as timedTests, must be introduced with one of sum, count, or variance, depending on the attribute of interest.

For example, the statistic expression (/ (sum timedTests) (count timedTests)) represents the mean test time in milliseconds.

Author:

Philip Aston

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other) Value based equality.
String	getDisplayName() Get the common display name.
StatisticExpression	getExpression() Return the StatisticExpression.
String	getExpressionString() Return the expression string.
boolean	getShowForCompositeStatistics() Return whether this view is relevant for totals of composite statistics.
int	hashCode() Implement Object.hashCode().
String	toString() Return a String representation of this ExpressionView.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getDisplayName

public String getDisplayName()

Get the common display name.

Returns:

The display name.

getExpression

public StatisticExpression getExpression()

Return the StatisticExpression.

Returns:

The StatisticExpression.

getExpressionString

public String getExpressionString()

Return the expression string.

Returns:

The string, or null if this view was built directly from a StatisticExpression.

getShowForCompositeStatistics

public boolean getShowForCompositeStatistics()

Return whether this view is relevant for totals of composite statistics. Many views (particularly those representing aggregate time, or averages) are ambiguous for composite statistics, so we don't show them.

Returns:

true => show this view for composite statistics.

equals

public boolean equals(Object other)

Value based equality.

Overrides:

equals in class Object

Parameters:

other - An Object to compare.

Returns:

true => other is equal to this object.

hashCode

public int hashCode()

Implement Object.hashCode().

Overrides:

hashCode in class Object

Returns:

an int value

toString

public String toString()

Return a String representation of this ExpressionView.

Overrides:

toString in class Object

Returns:

The String