at.srfg.miner.clientlib

Class Condition

Object

at.srfg.miner.clientlib.Condition

public class Condition
extends Object

The Condition is used to express (a) condition(s) on a result that a Tool can produce. The semantic is that the condition must be true at all times. If measurement results show that the condition is violated, an event is generated. At the MINER Server, one or more notifier(s) will handle the event. The default notifier, which is always present, logs the event to the database.

A Condition is composed of 1..N Subconditions which are instances of the Subcondition class. It is the Subcondition that is associated directly with a ResultHandle. The Condition defines how these Subconditions are logically combined. The logicalOperator can be set to Condition.ALL or Condition.ANY. The meaning is the following:

logicalOperator	description
ALL	the condition is fulfilled if all Subconditions are fulfilled
ANY	the condition is fulfilled as long as at least 1 Subcondition is fulfilled

In case of Condition.ANY, the holdTime defines for how long a subcondition is regarded as violated. In detail, it is considered violated in the time interval [t0 ; t0 + holdTime] where t0 is the time when the violation occured.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL The logical operator ALL defines that the condition is fulfilled if all subconditions are fulfilled.
static String	ANY The logical operator ANY defines that the condition is fulfilled as long as at least 1 subcondition is fulfilled.

Constructor Summary

Constructors

Constructor and Description
Condition() Default constructor
Condition(String operator) Constructs a new Condition with logical operator operator

Method Summary

Methods

Modifier and Type	Method and Description
Subcondition	addSubcondition(ResultHandle resultHandle, String comparator, double value) Creates a new Subcondition with the given parameters and adds it to this Condition.
Subcondition	addSubcondition(ResultHandle resultHandle, String comparator, float value) Creates a new Subcondition with the given parameters and adds it to this Condition.
Subcondition	addSubcondition(Subcondition subCondition) Adds a Subcondition.
String	getDescription() Gets the description.
double	getHoldTime() Gets the holdTime in [s].
int	getID() Gets the ID that identifies the Condition at the MINER core.
String	getLogicalOperator() Gets the logical operator.
Collection<Subcondition>	getSubconditions() Get all Subconditions.
void	setDescription(String description) Sets the description.
void	setHoldTime(double holdTimeSec) Sets the holdTime in [s].
void	setLogicalOperator(String operator) Sets the logical operator.

Methods inherited from class Object

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

Field Detail

ANY

public static final String ANY

The logical operator ANY defines that the condition is fulfilled as long as at least 1 subcondition is fulfilled.

ALL

public static final String ALL

The logical operator ALL defines that the condition is fulfilled if all subconditions are fulfilled.

Constructor Detail

Condition

public Condition()

Default constructor

Condition

public Condition(String operator)

Constructs a new Condition with logical operator operator

Parameters:

operator - the logical operator

Method Detail

setLogicalOperator

public void setLogicalOperator(String operator)

Sets the logical operator. Valid values are ALL and ANY.

Parameters:

operator - the operator

Throws:

IllegalArgumentException - if an unknown operator is specified.

getLogicalOperator

public String getLogicalOperator()

Gets the logical operator.

Returns:

the logical operator

setDescription

public void setDescription(String description)

Sets the description.

Parameters:

description - the description

getDescription

public String getDescription()

Gets the description.

Returns:

the description

setHoldTime

public void setHoldTime(double holdTimeSec)

Sets the holdTime in [s].

Parameters:

holdTimeSec - the holdTime in seconds

getHoldTime

public double getHoldTime()

Gets the holdTime in [s].

Returns:

the holdTime in seconds

addSubcondition

public Subcondition addSubcondition(ResultHandle resultHandle,
                           String comparator,
                           float value)

Creates a new Subcondition with the given parameters and adds it to this Condition.

Parameters:

resultHandle - The name of the result to which this subcondition is associated

comparator - A comparator, i.e. one of "<", ">", "<=", ">=", "==", "!="

value - The value to compare to

Returns:

the newly created Subcondition

addSubcondition

public Subcondition addSubcondition(ResultHandle resultHandle,
                           String comparator,
                           double value)

Creates a new Subcondition with the given parameters and adds it to this Condition.

Parameters:

resultHandle - The name of the result to which this subcondition is associated

comparator - A comparator, i.e. one of "<", ">", "<=", ">=", "==", "!="

value - The value to compare to

Returns:

the newly created Subcondition

addSubcondition

public Subcondition addSubcondition(Subcondition subCondition)

Adds a Subcondition.

Parameters:

subCondition - the Subcondition

Returns:

the input parameter subCondition

getSubconditions

public Collection<Subcondition> getSubconditions()

Get all Subconditions.

Returns:

the Subconditions

getID

public int getID()

Gets the ID that identifies the Condition at the MINER core.

Returns:

the ID