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>

A condition that support a number of property related sub-conditions. Important: This condition was originally created for alarm status querying, and then updated for tag querying. Be careful about changing it too much.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PropertyCondition.GroupCondition
static class	PropertyCondition.GroupConditionOperator
static class	PropertyCondition.GroupPropertyCondition
static class	PropertyCondition.GsonAdapter
static class	PropertyCondition.PropertyStateCondition
static class	PropertyCondition.PropertyStateOperator
static class	PropertyCondition.SubPropertyCondition

Constructor Summary

Constructors

Constructor	Description
PropertyCondition()

Method Summary

Modifier and Type	Method	Description
void	applyVersion(Version version)
PropertyCondition	defined(Property<?> property)	Adds a requirement that a property be defined.
PropertyCondition	defined(java.lang.String property)
boolean	equals(java.lang.Object o)
protected Property<?>	getAlarmProperty(java.lang.String propName)
PropertyCondition.GroupPropertyCondition	getGroupProperties()
Version	getVersion()
int	hashCode()
PropertyCondition	notDefined(Property<?> property)
PropertyCondition	notDefined(java.lang.String property)
<T> PropertyCondition	optionalProperty(Property<T> property, T value, ComparisonOperator op)	Adds an optional property sub-condition.
PropertyCondition	optionalProperty(java.lang.String property, java.lang.Object value, ComparisonOperator op)	Deprecated. as the string name was expected to be an alarm property.
PropertyCondition	overridden(Property<?> property)
PropertyCondition	overridden(java.lang.String property)
boolean	passes(PropertySet target)	Returns whether the provided value passes the condition.
<T> PropertyCondition	requiredProperty(Property<?> property, T value, ComparisonOperator op)	Adds a required property sub-condition.
PropertyCondition	requiredProperty(java.lang.String property, java.lang.Object value, ComparisonOperator op)	Deprecated. as the string name was expected to be an alarm property.
PropertyCondition	setGroupCondition(PropertyCondition.GroupPropertyCondition condition)	Will override previous set GroupPropertyCondition if one is set.
void	setPassOnAny(boolean value)	Sets whether the "defined" and "overridden" condition should pass on any match (true), or require all matches (false).

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyCondition

public PropertyCondition()

Method Detail

getGroupProperties

public PropertyCondition.GroupPropertyCondition getGroupProperties()

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

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

Deprecated.

as the string name was expected to be an alarm property. This class is now used more generally, so the Property based version should be used.

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

requiredProperty

public <T> PropertyCondition requiredProperty(Property<?> property,
                                              T value,
                                              ComparisonOperator op)

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

optionalProperty

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

Deprecated.

as the string name was expected to be an alarm property. This class is now used more generally, so * the Property based version should be used.

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

optionalProperty

public <T> PropertyCondition optionalProperty(Property<T> property,
                                              T value,
                                              ComparisonOperator op)

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

getAlarmProperty

protected Property<?> getAlarmProperty(java.lang.String propName)

defined

public PropertyCondition defined(Property<?> property)

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

defined

public PropertyCondition defined(java.lang.String property)

notDefined

public PropertyCondition notDefined(Property<?> property)

notDefined

public PropertyCondition notDefined(java.lang.String property)

setPassOnAny

public void setPassOnAny(boolean value)

Sets whether the "defined" and "overridden" condition should pass on any match (true), or require all matches (false).

overridden

public PropertyCondition overridden(Property<?> property)

overridden

public PropertyCondition overridden(java.lang.String property)

setGroupCondition

public PropertyCondition setGroupCondition(PropertyCondition.GroupPropertyCondition condition)

Will override previous set GroupPropertyCondition if one is set. If multiple are required they can be combined into one group.

applyVersion

public void applyVersion(Version version)

getVersion

@Nullable
public Version getVersion()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object