IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.kernel.statistics
Interface IStatTree

All Known Subinterfaces:
IScalar, IStat, IText

public interface IStatTree

The IStatTree interface is common to all statistical counters.

All counters in the statistics counter tree are capable of being parents of other counters.


Method Summary
 com.ibm.rational.test.lt.kernel.statistics.impl.Average getAverage(String name)
          Retrieves a child Average counter.
 com.ibm.rational.test.lt.kernel.statistics.impl.Average getAverage(String[] path)
          Retrieves a child Average counter.
 com.ibm.rational.test.lt.kernel.statistics.impl.Distribution getDistribution(String name)
          Retrieves a child Distribution counter.
 com.ibm.rational.test.lt.kernel.statistics.impl.Distribution getDistribution(String[] path)
          Retrieves a child Distribution counter.
 com.ibm.rational.test.lt.kernel.statistics.impl.Range getRange(String name)
          Retrieves a child Range counter.
 com.ibm.rational.test.lt.kernel.statistics.impl.Range getRange(String[] path)
          Retrieves a child Range counter.
 com.ibm.rational.test.lt.kernel.statistics.impl.Rate getRate(String name)
          Retrieves a child Rate counter.
 com.ibm.rational.test.lt.kernel.statistics.impl.Rate getRate(String[] path)
          Retrieves a child Rate counter.
 com.ibm.rational.test.lt.kernel.statistics.impl.Scalar getScalar(String name)
          Retrieves a child Scalar counter.
 com.ibm.rational.test.lt.kernel.statistics.impl.Scalar getScalar(String[] path)
          Retrieves a child Scalar counter.
 com.ibm.rational.test.lt.kernel.statistics.impl.StatTree getStat(String n, com.ibm.rational.test.lt.kernel.statistics.impl.StatType type)
          Retrieves a child counter.
 com.ibm.rational.test.lt.kernel.statistics.impl.Static getStatic(String name)
          Retrieves a child Static counter.
 com.ibm.rational.test.lt.kernel.statistics.impl.Static getStatic(String[] path)
          Retrieves a child Static counter.
 com.ibm.rational.test.lt.kernel.statistics.impl.StatTree getStructure(String name)
          Retrieves a child Structure counter.
 com.ibm.rational.test.lt.kernel.statistics.impl.StatTree getStructure(String[] path)
          Retrieves a child Structure counter.
 com.ibm.rational.test.lt.kernel.statistics.impl.Text getText(String name)
          Retrieves a child Text counter.
 com.ibm.rational.test.lt.kernel.statistics.impl.Text getText(String[] path)
          Retrieves a child Text counter.
 com.ibm.rational.test.lt.kernel.statistics.IVerificationPoint getVerificationPoint(String n)
          Retrieves a child VerificationPoint counter.
 com.ibm.rational.test.lt.kernel.statistics.IVerificationPoint getVerificationPoint(String[] path)
          Retrieves a child VerificationPoint counter.
 String makeDefinition()
          Creates the XML fragments that define this counter.
 String makeObservation(long time)
          Creates the XML fragments that constitute a sample for this counter.
 void setDescription(String desc)
          Sets the description field of the counter.
 

Method Detail

setDescription

void setDescription(String desc)
Sets the description field of the counter.

Parameters:
desc - the description string.

getStat

com.ibm.rational.test.lt.kernel.statistics.impl.StatTree getStat(String n,
                                                                 com.ibm.rational.test.lt.kernel.statistics.impl.StatType type)
Retrieves a child counter.

All counters are created by getStat(). If a child counter of the same name and type (StatType already exists, a reference to the existing counter is returned. Otherwise, a child counter is created.

Parameters:
n - The name of the desired counter.
type - The type of the desired counter.
Returns:
A reference to the requested counter.

getStructure

com.ibm.rational.test.lt.kernel.statistics.impl.StatTree getStructure(String name)
Retrieves a child Structure counter.

Uses getStat() to find or create a Structure counter of the given name.

Parameters:
name - The name of the desired Structure counter.
Returns:
A reference to the requested Structure counter.

getStructure

com.ibm.rational.test.lt.kernel.statistics.impl.StatTree getStructure(String[] path)
Retrieves a child Structure counter.

Uses getStat() to find or create a Structure counter of the given path. The path is relative to this. Each element of the path array specifies one level in the statistics tree hierarchy. All counters along the path that do not already exist will be created. All counters that are created by this method will be type STRUCTURE.

Parameters:
path - The path to the desired Structure counter.
Returns:
A reference to the requested Structure counter.

getText

com.ibm.rational.test.lt.kernel.statistics.impl.Text getText(String name)
Retrieves a child Text counter.

Uses getStat() to find or create a Text counter of the given name.

Parameters:
name - The name of the desired Text counter.
Returns:
A reference to the requested Text counter.

getText

com.ibm.rational.test.lt.kernel.statistics.impl.Text getText(String[] path)
Retrieves a child Text counter.

Uses getStat() to find or create a Text counter of the given path. The path is relative to this. Each element of the path array specifies one level in the statistics tree hierarchy. All counters along the path that do not already exist will be created. All counters that are created by this method except the last element of path will be type STRUCTURE.

Parameters:
path - The path to the desired Text counter.
Returns:
A reference to the requested Text counter.

getStatic

com.ibm.rational.test.lt.kernel.statistics.impl.Static getStatic(String name)
Retrieves a child Static counter.

Uses getStat() to find or create a Static counter of the given name.

Parameters:
name - The name of the desired Static counter.
Returns:
A reference to the requested Static counter.

getStatic

com.ibm.rational.test.lt.kernel.statistics.impl.Static getStatic(String[] path)
Retrieves a child Static counter.

Uses getStat() to find or create a Static counter of the given path. The path is relative to this. Each element of the path array specifies one level in the statistics tree hierarchy. All counters along the path that do not already exist will be created. All counters that are created by this method except the last element of path will be type STRUCTURE.

Parameters:
path - The path to the desired counter.
Returns:
A reference to the requested Static counter.

getScalar

com.ibm.rational.test.lt.kernel.statistics.impl.Scalar getScalar(String name)
Retrieves a child Scalar counter.

Uses getStat() to find or create a Scalar counter of the given name.

Parameters:
name - The name of the desired Scalar counter.
Returns:
A reference to the requested Scalar counter.

getScalar

com.ibm.rational.test.lt.kernel.statistics.impl.Scalar getScalar(String[] path)
Retrieves a child Scalar counter.

Uses getStat() to find or create a Scalar counter of the given path. The path is relative to this. Each element of the path array specifies one level in the statistics tree hierarchy. All counters along the path that do not already exist will be created. All counters that are created by this method except the last element of path will be type STRUCTURE.

Parameters:
path - The path to the desired Scalar counter.
Returns:
A reference to the requested Scalar counter.

getRate

com.ibm.rational.test.lt.kernel.statistics.impl.Rate getRate(String name)
Retrieves a child Rate counter.

Uses getStat() to find or create a Rate counter of the given name.

Parameters:
name - The name of the desired Rate counter.
Returns:
A reference to the requested Rate counter.

getRate

com.ibm.rational.test.lt.kernel.statistics.impl.Rate getRate(String[] path)
Retrieves a child Rate counter.

Uses getStat() to find or create a Rate counter of the given path. The path is relative to this. Each element of the path array specifies one level in the statistics tree hierarchy. All counters along the path that do not already exist will be created. All counters that are created by this method except the last element of path will be type STRUCTURE.

Parameters:
path - The path to the desired Rate counter.
Returns:
A reference to the requested Rate counter.

getAverage

com.ibm.rational.test.lt.kernel.statistics.impl.Average getAverage(String name)
Retrieves a child Average counter.

Uses getStat() to find or create a Average counter of the given name.

Parameters:
name - The name of the desired Average counter.
Returns:
A reference to the requested Average counter.

getAverage

com.ibm.rational.test.lt.kernel.statistics.impl.Average getAverage(String[] path)
Retrieves a child Average counter.

Uses getStat() to find or create a Average counter of the given path. The path is relative to this. Each element of the path array specifies one level in the statistics tree hierarchy. All counters along the path that do not already exist will be created. All counters that are created by this method except the last element of path will be type STRUCTURE.

Parameters:
path - The path to the desired Average counter.
Returns:
A reference to the requested Average counter.

getRange

com.ibm.rational.test.lt.kernel.statistics.impl.Range getRange(String name)
Retrieves a child Range counter.

Uses getStat() to find or create a Range counter of the given name.

Parameters:
name - The name of the desired Range counter.
Returns:
A reference to the requested Range counter.

getRange

com.ibm.rational.test.lt.kernel.statistics.impl.Range getRange(String[] path)
Retrieves a child Range counter.

Uses getStat() to find or create a Range counter of the given path. The path is relative to this. Each element of the path array specifies one level in the statistics tree hierarchy. All counters along the path that do not already exist will be created. All counters that are created by this method except the last element of path will be type STRUCTURE.

Parameters:
path - The path to the desired Range counter.
Returns:
A reference to the requested Range counter.

getDistribution

com.ibm.rational.test.lt.kernel.statistics.impl.Distribution getDistribution(String name)
Retrieves a child Distribution counter.

Uses getStat() to find or create a Distribution counter of the given name.

Parameters:
name - The name of the desired Distribution counter.
Returns:
A reference to the requested Distribution counter.

getDistribution

com.ibm.rational.test.lt.kernel.statistics.impl.Distribution getDistribution(String[] path)
Retrieves a child Distribution counter.

Uses getStat() to find or create a Distribution counter of the given path. The path is relative to this. Each element of the path array specifies one level in the statistics tree hierarchy. All counters along the path that do not already exist will be created. All counters that are created by this method except the last element of path will be type STRUCTURE.

Parameters:
path - The path to the desired Distribution counter.
Returns:
A reference to the requested Distribution counter.

getVerificationPoint

com.ibm.rational.test.lt.kernel.statistics.IVerificationPoint getVerificationPoint(String n)
Retrieves a child VerificationPoint counter.

Uses getStat() to find or create a VerificationPoint counter of the given name.

Parameters:
name - The name of the desired VerificationPoint counter.
Returns:
A reference to the requested VerificationPoint counter.

getVerificationPoint

com.ibm.rational.test.lt.kernel.statistics.IVerificationPoint getVerificationPoint(String[] path)
Retrieves a child VerificationPoint counter.

Uses getStat() to find or create a VerificationPoint counter of the given path. The path is relative to this. Each element of the path array specifies one level in the statistics tree hierarchy. All counters along the path that do not already exist will be created. All counters that are created by this method except the last element of path will be type STRUCTURE.

Parameters:
path - The path to the desired VerificationPoint counter.
Returns:
A reference to the requested VerificationPoint counter.

makeDefinition

String makeDefinition()
Creates the XML fragments that define this counter.

Used for internal testing purposes only.

Returns:
The XML string.

makeObservation

String makeObservation(long time)
Creates the XML fragments that constitute a sample for this counter.

Used for internal testing purposes only.

Parameters:
time - The timestamp of the sample
Returns:
The XML string.

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.