edu.ucsb.nmsl.tools
Interface Statistic

All Known Implementing Classes:

BaseStatistic, DataSetStatistic, DoubleStatistic, IntegerStatistic, PercentageStatistic

public interface Statistic

This interface allows for the storage of statistical information for a specific running of AutoCap and associate a name with the information for efficient retrieval and convenience when displaying the data. This convenience comes from the fact that the statistic is converted to a string by prepending the name associated with the statistic to a string and the the value of the Statistic instance.

Version:

1.0

See Also:

StatisticsPackage

Method Summary

java.lang.String	displayString() This method returns a string that can be used to neatly show the statistical information associated with a particular instance.
java.lang.String	getName() This method returns the name associated with the statistical information.
java.lang.Object	getValue() This method returns the value of the statistical information.
void	setName(java.lang.String n) This method sets the name associated with the statistical information.
void	setValue(java.lang.Object o) This method sets the value of the statistical information.

Method Detail

getName

java.lang.String getName()

This method returns the name associated with the statistical information.

Returns:

The statistic name as a String.

getValue

java.lang.Object getValue()

This method returns the value of the statistical information.

Returns:

The statistical information as an Object. This instance is usually one of the wrapper classes for primitive types such as Integer or Double.

setName

void setName(java.lang.String n)

This method sets the name associated with the statistical information.

Parameters:

n - - The name to be associated with the statistical information.

setValue

void setValue(java.lang.Object o)

This method sets the value of the statistical information.

Parameters:

o - - The statistical information as an Object. This instance is usually one of the wrapper classes for primitive types such as Integer or Double.

displayString

java.lang.String displayString()

This method returns a string that can be used to neatly show the statistical information associated with a particular instance.

Returns:

A string representing the statistical information. This string usually takes the form of <Name>: <Value>