Package com.inductiveautomation.ignition.common.alarming.query.conditions

Class PropertyCondition

java.lang.Object

com.inductiveautomation.ignition.common.alarming.query.conditions.PropertyCondition

All Implemented Interfaces:

Condition<PropertySet>, java.io.Serializable

public class PropertyCondition
extends java.lang.Object
implements Condition<PropertySet>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	PropertyCondition.SubPropertyCondition

Constructor Summary

Constructors

Constructor	Description
PropertyCondition()

Method Summary

Modifier and Type	Method	Description
PropertyCondition	defined(java.lang.String property)	Adds a requirement that a property be defined.
PropertyCondition	optionalProperty(java.lang.String property, java.lang.Object value, ComparisonOperator op)	Adds an optional property sub-condition.
boolean	passes(PropertySet target)	Returns whether the provided value passes the condition.
PropertyCondition	requiredProperty(java.lang.String property, java.lang.Object value, ComparisonOperator op)	Adds a required property sub-condition.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyCondition

public PropertyCondition()

Method Detail

passes

public boolean passes(PropertySet target)

Description copied from interface: Condition

Returns whether the provided value passes the condition.

Specified by:

passes in interface Condition<PropertySet>

requiredProperty

public PropertyCondition requiredProperty(java.lang.String property,
                                          java.lang.Object value,
                                          ComparisonOperator op)

Adds a required property sub-condition. All required sub-conditions must pass for the overall condition to pass.

optionalProperty

public PropertyCondition optionalProperty(java.lang.String property,
                                          java.lang.Object value,
                                          ComparisonOperator op)

Adds an optional property sub-condition. One optional sub-condition must pass for the whole condition to pass.

defined

public PropertyCondition defined(java.lang.String property)

Adds a requirement that a property be defined. All of these conditions must pass for the overall condition to pass.