org.opennms.netmgt.threshd

Interface ThresholdEvaluatorState

All Known Implementing Classes:

AbstractThresholdEvaluatorState, ThresholdEvaluatorAbsoluteChange.ThresholdEvaluatorStateAbsoluteChange, ThresholdEvaluatorHighLow.ThresholdEvaluatorStateHighLow, ThresholdEvaluatorRearmingAbsoluteChange.ThresholdEvaluatorStateRearmingAbsoluteChange, ThresholdEvaluatorRelativeChange.ThresholdEvaluatorStateRelativeChange

public interface ThresholdEvaluatorState

Provides a method to evaluate a threshold and do basic population of events. There is an instance of ThresholdEvaluatorState for each configured thresholding type on each configured data source on each configured node/interface/etc.. The object that implements this interface usually also stores state (hence the name).

Version:

$Id: $

Author:

ranger

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ThresholdEvaluatorState.Status

Method Summary

Modifier and Type	Method and Description
void	clearState() clearState
ThresholdEvaluatorState.Status	evaluate(double dsValue) evaluate
ThresholdEvaluatorState	getCleanClone() Returns a "clean" (armed, non-triggered) clone of this object
Event	getEventForState(ThresholdEvaluatorState.Status status, Date date, double dsValue, CollectionResourceWrapper resource) getEventForState
BaseThresholdDefConfigWrapper	getThresholdConfig() getThresholdConfig
boolean	isTriggered() Return true if current state is TRIGGERED

Method Detail

evaluate

ThresholdEvaluatorState.Status evaluate(double dsValue)

evaluate

Parameters:

dsValue - a double.

Returns:

a ThresholdEvaluatorState.Status object.

getEventForState

Event getEventForState(ThresholdEvaluatorState.Status status,
                       Date date,
                       double dsValue,
                       CollectionResourceWrapper resource)

getEventForState

Parameters:

status - a ThresholdEvaluatorState.Status object.

date - a Date object.

dsValue - a double.

resource - a CollectionResourceWrapper object.

Returns:

a Event object.

isTriggered

boolean isTriggered()

Return true if current state is TRIGGERED

Returns:

a boolean.

clearState

void clearState()

clearState

getThresholdConfig

BaseThresholdDefConfigWrapper getThresholdConfig()

getThresholdConfig

Returns:

a BaseThresholdDefConfigWrapper object.

getCleanClone

ThresholdEvaluatorState getCleanClone()

Returns a "clean" (armed, non-triggered) clone of this object

Returns:

a ThresholdEvaluatorState object.