com.inductiveautomation.ignition.common.search.conditions

Class BasicPropertyCondition

java.lang.Object

com.inductiveautomation.ignition.common.search.conditions.BasicPropertyCondition

All Implemented Interfaces:

Condition<PropertySet>, java.io.Serializable

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

Value condition appropriate for use with simple Properties that have a single String-able value or numeric value. Also accepts (*) and (?) wildcards for string values, but you must use the ComparisonOperator.Like when constructing the condition. The compiled pattern is cached for repeated searches when using the Like operator.

Since:

8.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BasicPropertyCondition.SubPropertyCondition

Constructor Summary

Constructors

Constructor and Description
BasicPropertyCondition()

Method Summary

Modifier and Type	Method and Description
BasicPropertyCondition	anyRequiredProperty(java.util.List<Property<?>> properties, java.lang.Object value, ComparisonOperator op) Adds a sub-conditions that can check multiple properties for the same condition.
java.util.List<Property<?>>	getProperties() Returns a collated list of all the properties used in all the internal AND conditions.
boolean	passes(PropertySet target) Returns whether the provided value passes the condition.
BasicPropertyCondition	requiredProperty(Property<?> 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

BasicPropertyCondition

public BasicPropertyCondition()

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 BasicPropertyCondition requiredProperty(Property<?> 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.

anyRequiredProperty

public BasicPropertyCondition anyRequiredProperty(java.util.List<Property<?>> properties,
                                                  java.lang.Object value,
                                                  ComparisonOperator op)

Adds a sub-conditions that can check multiple properties for the same condition. Any property that meets the sub-condition will allow the overall condition to pass.

getProperties

public java.util.List<Property<?>> getProperties()

Returns a collated list of all the properties used in all the internal AND conditions. Useful to give an idea of the composition of the condition.