Package com.inductiveautomation.ignition.common

Enum ComparisonOperator

java.lang.Object

java.lang.Enum<ComparisonOperator>

com.inductiveautomation.ignition.common.ComparisonOperator

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ComparisonOperator>

public enum ComparisonOperator
extends java.lang.Enum<ComparisonOperator>

An enum listing the possible comparison operations. Some only apply to numbers, others to strings, dates, etc.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Equal
GreaterThan
GreaterThanEqual
LessThan
LessThanEqual
Like
NotEqual
NotLike

Method Summary

Modifier and Type	Method	Description
boolean	canEvaluateStrings()
boolean	evaluate(SimplePatternSearcher searcher, java.lang.String pattern, java.lang.String input)
boolean	evaluate(java.lang.Number a, java.lang.Number b)	Compares two number according to the operator.
boolean	evaluate(java.lang.String pattern, java.lang.String input)
static ComparisonOperator	fromString(java.lang.String value)	Similar to valueOf, but also matches display name value (symbols, like "=")
java.lang.String	getDisplayValue()	Returns the short display value of the enum's value eg.
java.lang.String	toString()
static ComparisonOperator	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ComparisonOperator[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GreaterThan

public static final ComparisonOperator GreaterThan

GreaterThanEqual

public static final ComparisonOperator GreaterThanEqual

LessThan

public static final ComparisonOperator LessThan

LessThanEqual

public static final ComparisonOperator LessThanEqual

Equal

public static final ComparisonOperator Equal

NotEqual

public static final ComparisonOperator NotEqual

Like

public static final ComparisonOperator Like

NotLike

public static final ComparisonOperator NotLike

Method Detail

values

public static ComparisonOperator[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ComparisonOperator c : ComparisonOperator.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ComparisonOperator valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

fromString

public static ComparisonOperator fromString(java.lang.String value)

Similar to valueOf, but also matches display name value (symbols, like "=")

getDisplayValue

public java.lang.String getDisplayValue()

Returns the short display value of the enum's value eg. <, =, etc.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<ComparisonOperator>

evaluate

public boolean evaluate(java.lang.Number a,
                        java.lang.Number b)

Compares two number according to the operator. Note: The numbers will be converted to double for comparison, so if that is not appropriate, a different comparison mechanism should be used.

evaluate

public boolean evaluate(java.lang.String pattern,
                        java.lang.String input)

evaluate

public boolean evaluate(SimplePatternSearcher searcher,
                        java.lang.String pattern,
                        java.lang.String input)

canEvaluateStrings

public boolean canEvaluateStrings()