net.openwings.container.utilities
Class PerformanceThreshold

java.lang.Object
  net.openwings.container.utilities.PerformanceThreshold

All Implemented Interfaces:

java.io.Serializable

public class PerformanceThreshold

extends java.lang.Object

implements java.io.Serializable

This class describes the thresholds for GREEN/YELLOW/RED status for a particular type of performance report.

See Also:

Serialized Form

Constructor Summary

PerformanceThreshold()
Default Constructor.

PerformanceThreshold(java.lang.String reportName, float yellowThreshold, float redThreshold)
This is the single public constructor for this class

Method Summary

float	getRedThreshold() This method returns the threshold indicating imminent failure.
java.lang.String	getReportName() This method returns the name of the report.
float	getYellowThreshold() This method returns the threshold indicating degraded operation.
void	setRedThreshold(float redThreshold) This method sets the threshold indicating imminent failure.
void	setReportName(java.lang.String reportName) This method sets the name of the report.
void	setYellowThreshold(float yellowThreshold) This method sets the threshold indicating degraded operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PerformanceThreshold

public PerformanceThreshold()

Default Constructor.

PerformanceThreshold

public PerformanceThreshold(java.lang.String reportName,
                            float yellowThreshold,
                            float redThreshold)

This is the single public constructor for this class

Parameters:

reportName - the type of report for which this threshold is used, corresponding to the PerformanceReport.name field.

yellowThreshold - float value between 0.0 and 1.0 (inclusive) representing the ratio in a PerformanceReport.usage field that is the boundary between PerformanceReport.GREEN and PerformanceReport.YELLOW.

redThreshold - float value between 0.0 and 1.0 (inclusive) representing the ratio in a PerformanceReport.usage field that is the boundary between PerformanceReport.YELLOW and PerformanceReport.RED. Should be greater than or equal to yellowThreshold.

Method Detail

getReportName

public java.lang.String getReportName()

This method returns the name of the report.

Returns:

the type of report for which this threshold is used, corresponding to the PerformanceReport.name field.

setReportName

public void setReportName(java.lang.String reportName)

This method sets the name of the report.

Parameters:

reportName - the type of report for which this threshold is used, corresponding to the PerformanceReport.name field.

getYellowThreshold

public float getYellowThreshold()

This method returns the threshold indicating degraded operation.

Returns:

float value between 0.0 and 1.0 (inclusive) representing the ratio in a PerformanceReport.usage field that is the boundary between PerformanceReport.GREEN and PerformanceReport.YELLOW.

setYellowThreshold

public void setYellowThreshold(float yellowThreshold)

This method sets the threshold indicating degraded operation.

Parameters:

yellowThreshold - float value between 0.0 and 1.0 (inclusive) representing the ratio in a PerformanceReport.usage field that is the boundary between PerformanceReport.GREEN and PerformanceReport.YELLOW.

getRedThreshold

public float getRedThreshold()

This method returns the threshold indicating imminent failure.

Returns:

float value between 0.0 and 1.0 (inclusive) representing the ratio in a PerformanceReport.usage field that is the boundary between PerformanceReport.YELLOW and PerformanceReport.RED. Should be greater than or equal to yellowThreshold.

setRedThreshold

public void setRedThreshold(float redThreshold)

This method sets the threshold indicating imminent failure.

Parameters:

redThreshold - float value between 0.0 and 1.0 (inclusive) representing the ratio in a PerformanceReport.usage field that is the boundary between PerformanceReport.YELLOW and PerformanceReport.RED. Should be greater than or equal to yellowThreshold.