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

Interface IStatTree

All Known Subinterfaces:

IScalar, IStat, IText, IVerificationPoint

Deprecated.

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.

See Also:

ICounterNode

Method Summary

Methods

Modifier and Type	Method and Description
IStat	getAverage(String name) Deprecated.
IStat	getAverage(String[] path) Deprecated.
IStat	getDistribution(String name) Deprecated.
IStat	getDistribution(String[] path) Deprecated.
IStat	getRange(String name) Deprecated.
IStat	getRange(String[] path) Deprecated.
com.ibm.rational.test.lt.kernel.statistics.IRate	getRate(String name) Deprecated.
com.ibm.rational.test.lt.kernel.statistics.IRate	getRate(String[] path) Deprecated.
IScalar	getScalar(String name) Deprecated.
IScalar	getScalar(String[] path) Deprecated.
IStatTree	getStat(String n, StatType type) Deprecated.
IScalar	getStatic(String name) Deprecated.
IScalar	getStatic(String[] path) Deprecated.
IStatTree	getStructure(String name) Deprecated.
IStatTree	getStructure(String[] path) Deprecated.
IText	getText(String name) Deprecated.
IText	getText(String[] path) Deprecated.
IVerificationPoint	getVerificationPoint(String n) Deprecated.
IVerificationPoint	getVerificationPoint(String[] path) Deprecated.
int	getVersion() Deprecated. Returns the statistics engine version.
String	makeDefinition() Deprecated. This method returns null in the new framework.
String	makeObservation(long time) Deprecated. This method returns null in the new framework.
void	setDescription(String desc) Deprecated.

Method Detail

setDescription

void setDescription(String desc)

Deprecated.

Sets the description field of the counter.

This method has no effect in the new framework.

Parameters:

desc - the description string.

getStat

IStatTree getStat(String n,
                StatType type)

Deprecated.

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.

See Also:

ICounterNode#getNode(String, com.ibm.rational.test.lt.execution.stats.descriptor.definition.CounterType)

getStructure

IStatTree getStructure(String name)

Deprecated.

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.

See Also:

ICounterNode.getFolder(String)

getStructure

IStatTree getStructure(String[] path)

Deprecated.

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.

See Also:

ICounterNode.getFolder(String)

getText

IText getText(String name)

Deprecated.

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.

See Also:

ICounterNode.getTextCounter(String)

getText

IText getText(String[] path)

Deprecated.

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.

See Also:

ICounterNode.getTextCounter(String)

getStatic

IScalar getStatic(String name)

Deprecated.

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.

See Also:

ICounterNode.getCountCounter(String), ICounterNode.getIncrementCounter(String)

getStatic

IScalar getStatic(String[] path)

Deprecated.

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.

See Also:

ICounterNode.getCountCounter(String), ICounterNode.getIncrementCounter(String)

getScalar

IScalar getScalar(String name)

Deprecated.

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.

See Also:

ICounterNode.getCountCounter(String), ICounterNode.getIncrementCounter(String)

getScalar

IScalar getScalar(String[] path)

Deprecated.

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.

See Also:

ICounterNode.getCountCounter(String), ICounterNode.getIncrementCounter(String)

getRate

com.ibm.rational.test.lt.kernel.statistics.IRate getRate(String name)

Deprecated.

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.

See Also:

ICounterNode.getCountCounter(String), ICounterNode.getIncrementCounter(String), ICounterNode.getValueCounter(String)

getRate

com.ibm.rational.test.lt.kernel.statistics.IRate getRate(String[] path)

Deprecated.

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.

See Also:

ICounterNode.getCountCounter(String), ICounterNode.getIncrementCounter(String), ICounterNode.getValueCounter(String)

getAverage

IStat getAverage(String name)

Deprecated.

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.

See Also:

ICounterNode.getValueCounter(String)

getAverage

IStat getAverage(String[] path)

Deprecated.

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.

See Also:

ICounterNode.getValueCounter(String)

getRange

IStat getRange(String name)

Deprecated.

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.

See Also:

ICounterNode.getValueCounter(String)

getRange

IStat getRange(String[] path)

Deprecated.

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.

See Also:

ICounterNode.getValueCounter(String)

getDistribution

IStat getDistribution(String name)

Deprecated.

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.

See Also:

ICounterNode.getValueCounter(String)

getDistribution

IStat getDistribution(String[] path)

Deprecated.

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.

See Also:

ICounterNode.getValueCounter(String)

getVerificationPoint

IVerificationPoint getVerificationPoint(String n)

Deprecated.

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

IVerificationPoint getVerificationPoint(String[] path)

Deprecated.

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()

Deprecated. This method returns null in the new framework.

Creates the XML fragments that define this counter.

Used for internal testing purposes only.

Returns:

The XML string.

makeObservation

String makeObservation(long time)

Deprecated. This method returns null in the new framework.

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.

getVersion

int getVersion()

Deprecated.

Returns the statistics engine version.

Returns:

1 for the statistics engine of versions lower to 8.8, 2 for versions 8.8 and more.