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

Class StatType



  • public class StatType
    extends Object
    This class provides a list of valid statistical counter types.

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

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static StatType[] ALL_TYPES
      An array of all the known StatTypes
      static StatType AVERAGE
      An AVERAGE counter represents a collection of values which should be averaged.
      static StatType DISTRIBUTION
      A DISTRIBUTION counter represents a collection of values which should be averaged and a minimum and maximum value are of interest.
      static int iAVERAGE
      The integer value of the AVERAGE StatType.
      static int iDISTRIBUTION
      The integer value of the DISTRIBUTION 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 int iVERIFICATION_POINT
      The integer value of the VERIFICATION_POINT 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.
      static StatType VERIFICATION_POINT
      A VERIFICATION_POINT counter represents the results of a test verification point.
    • Constructor Summary

      Constructors 
      Modifier Constructor and Description
      protected StatType(String n, int v)
      Used for internal testing purposes only.
    • Field Detail

      • iSTRUCTURE

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

        Used for internal testing purposes only.

      • iRATE

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

        Used for internal testing purposes only.

      • iAVERAGE

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

        Used for internal testing purposes only.

      • iRANGE

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

        Used for internal testing purposes only.

      • iSCALAR

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

        Used for internal testing purposes only.

      • iSTATIC

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

        Used for internal testing purposes only.

      • iTEXT

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

        Used for internal testing purposes only.

      • iDISTRIBUTION

        public static final int iDISTRIBUTION
        The integer value of the DISTRIBUTION StatType.

        Used for internal testing purposes only.

      • iVERIFICATION_POINT

        public static final int iVERIFICATION_POINT
        The integer value of the VERIFICATION_POINT StatType.

        Used for internal testing purposes only.

      • 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.
      • DISTRIBUTION

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

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

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

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

      • VERIFICATION_POINT

        public static final StatType VERIFICATION_POINT
        A VERIFICATION_POINT counter represents the results of a test verification point. A verification point can have four different verdicts: PASS, FAIL, ERROR, and INCONCLUSIVE.

        A VERIFICATION_POINT counter keeps a SCALAR sub-counter for each of the different possible verdicts. Incrementing a VERIFICATION_POINT count increments the sub-counter corresponding to the given verdict.

        A VERFICATION_POINT's SCALAR counters are 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.

      • ALL_TYPES

        public static final StatType[] ALL_TYPES
        An array of all the known StatTypes
    • Constructor Detail

      • StatType

        protected StatType(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 String toString()
        Returns the name of the StatType.

        Used for internal testing purposes only.

        Overrides:
        toString in class Object
        Returns:
        The string version of the type.
IBM Rational Performance Tester TES

© Copyright IBM Corp. 2013. All rights reserved.