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
 StatTree getStat(java.lang.String n, StatType type)
          Retrieves a child counter.
 java.lang.String makeDefinition()
          Creates the XML fragments that define this counter.
 java.lang.String makeObservation(long time)
          Creates the XML fragments that constitute a sample for this counter.
 void setDescription(java.lang.String desc)
          Sets the description field of the counter.
 

Method Detail

setDescription

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

Parameters:
desc - the description string.

getStat

public StatTree getStat(java.lang.String n,
                        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.

makeDefinition

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

Used for internal testing purposes only.

Returns:
The XML string.

makeObservation

public java.lang.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.


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