com.ibm.rational.test.lt.kernel.statistics.impl
Class StatType

java.lang.Object
  extended bycom.ibm.rational.test.lt.kernel.statistics.impl.StatType

public class StatType
extends java.lang.Object

This class provides a list of valid statistical counter types.

The constants are used as arguments to IStatTree.getStat().


Field Summary
static StatType AVERAGE
          An AVERAGE counter represents a collection of values which should be averaged.
static int iAVERAGE
          The integer value of the AVERAGE StatType.
static int iRANGE
          The integer value of the RANGE StatType.
static int iRATE
          The integer value of the RATE StatType.
static int iSCALAR
          The integer value of the SCALAR StatType.
static int iSTATIC
          The integer value of the STATIC StatType.
static int iSTRUCTURE
          The integer value of the STRUCTURE StatType.
static int iTEXT
          The integer value of the TEXT StatType.
static StatType RANGE
          A RANGE counter represents a collection of values which should be averaged and a minimum and maximum value are of interest.
static StatType RATE
          A RATE counter represents a number of occurrences over a time period.
static StatType SCALAR
          A SCALAR counter is used when a simple count of events or objects is desired.
static StatType STATIC
          A STATIC counter is SCALAR that is used to provide the cumulative value for the life of the counter.
static StatType STRUCTURE
          A STRUCTURE StatType is specified when the only purpose of the counter is to build hierarchy for other counters.
static StatType TEXT
          A TEXT counter is used for values that do not fit the other types.
 
Constructor Summary
protected StatType(java.lang.String n, int v)
          Used for internal testing purposes only.
 
Method Summary
 int intValue()
          Returns this StatType's integer equivalent.
 java.lang.String toString()
          Returns the name of the StatType.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

iSTRUCTURE

public static final int iSTRUCTURE
The integer value of the STRUCTURE StatType.

Used for internal testing purposes only.

See Also:
Constant Field Values

iRATE

public static final int iRATE
The integer value of the RATE StatType.

Used for internal testing purposes only.

See Also:
Constant Field Values

iAVERAGE

public static final int iAVERAGE
The integer value of the AVERAGE StatType.

Used for internal testing purposes only.

See Also:
Constant Field Values

iRANGE

public static final int iRANGE
The integer value of the RANGE StatType.

Used for internal testing purposes only.

See Also:
Constant Field Values

iSCALAR

public static final int iSCALAR
The integer value of the SCALAR StatType.

Used for internal testing purposes only.

See Also:
Constant Field Values

iSTATIC

public static final int iSTATIC
The integer value of the STATIC StatType.

Used for internal testing purposes only.

See Also:
Constant Field Values

iTEXT

public static final int iTEXT
The integer value of the TEXT StatType.

Used for internal testing purposes only.

See Also:
Constant Field Values

STRUCTURE

public static final StatType STRUCTURE
A STRUCTURE StatType is specified when the only purpose of the counter is to build hierarchy for other counters.


RATE

public static final StatType RATE
A RATE counter represents a number of occurrences over a time period.

The value of a RATE counter is modified with the IStat interface.

A RATE counter is only reported if at least one data point has been submitted in the current reporting interval. When a RATE counter value is reported to the workbench, it is reset to 0. The workbench sums all RATE counters with the same name from all driver computers in a test run and divides by the time interval to produce the final value.

Example, a transaction hit rate is reported via a RATE counter.


AVERAGE

public static final StatType AVERAGE
An AVERAGE counter represents a collection of values which should be averaged.

The value of an AVERAGE counter is modified with the IStat interface.

An AVERAGE counter is only reported if at least one data point has been submitted in the current reporting interval. When an AVERAGE counter value is reported to the workbench, it is reset to 0. The workbench sums all AVERAGE counters with the same name from all driver computers in a test run and calculates the cumulative average to produce the final value.

Example, an HTTP page element response time is reported via an AVERAGE counter.


RANGE

public static final StatType RANGE
A RANGE counter represents a collection of values which should be averaged and a minimum and maximum value are of interest.

The value of a RANGE counter is modified with the IStat interface.

A RANGE counter is only reported if at least one data point has been submitted in the current reporting interval. When a RANGE counter value is reported to the workbench, it is reset to 0. The workbench processes all RANGE counters with the same name from all driver computers in a test run and calculates the cumulative average and minimum and maximum to produce the final values.

Example, a transaction elapsed time is reported via a RANGE counter.


SCALAR

public static final StatType SCALAR
A SCALAR counter is used when a simple count of events or objects is desired.

The value of a SCALAR counter is modified via the IScalar interface.

A SCALAR counter is only reported if it has been modified in the current reporting interval. When a SCALAR counter is reported it is reset to 0. The workbench treats unreported SCALAR counters as 0.


STATIC

public static final StatType STATIC
A STATIC counter is SCALAR that is used to provide the cumulative value for the life of the counter.

The value of a STATIC counter is modified with the IScalar interface.

A STATIC counter is only reported if it has been modified in the current reporting interval. When a STATIC counter is reported it is not reset to 0. The workbench treats unreported STATIC counters as unchanged.

Example, the number of active users is reported via a STATIC.


TEXT

public static final StatType TEXT
A TEXT counter is used for values that do not fit the other types.

Constructor Detail

StatType

protected StatType(java.lang.String n,
                   int v)

Used for internal testing purposes only. Creates a new StatType.

A StatType is used as an argument to IStatTree.getStat(). The class that implements IStatTree.getStat() must know what types to expect.

Parameters:
n - the name of the type
v - the internal integer value assigned to this type.
Method Detail

intValue

public int intValue()
Returns this StatType's integer equivalent.

Used for internal testing purposes only.

Returns:
The integer value.

toString

public java.lang.String toString()
Returns the name of the StatType.

Used for internal testing purposes only.

Returns:
The string version of the type.


Copyright (c) IBM Corp. and others 2005. All rights reserved