Package org.odpi.openmetadata.frameworks.governanceaction.search

Enum Class PropertyComparisonOperator

java.lang.Object

java.lang.Enum<PropertyComparisonOperator>

org.odpi.openmetadata.frameworks.governanceaction.search.PropertyComparisonOperator

All Implemented Interfaces:

Serializable, Comparable<PropertyComparisonOperator>, Constable

public enum PropertyComparisonOperator
extends Enum<PropertyComparisonOperator>

PropertyComparisonOperator is used for search requests against a metadata store. It defines how the properties should be compared to find a matching result. The property comparison operator values are:

• EQUAL: when the property has a value that precisely equals the provided value. This is the default.
• NOT_EQUAL: when the property has a value that is not equal to the provided value.
• LESS_THAN: when the property has a value that is strictly less than the provided value.
• LESS_THAN_OR_EQUAL: when the property has a value that is less than, or equal to, the provided value.
• GREATER_THAN: when the property has a value that is strictly greater than the provided value.
• GREATER_THAN_OR_EQUAL: when the property has a value that is greater than, or equal to, the provided value.
• IN_LIST: when the property has a value that matches at least one element of the provided list of values.
• IS_NULL: when the property has no value.
• IS_NOT_NULL: when the property has any non-null value.
• LIKE: when the property has a value that matches the provided regular expression. This should only be applied to String properties, and should still be used even for exact matches for String properties.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EQ	Equal to.
GT	Greater than.
GTE	Greater than or equal to.
IN	Has a value of at least one in the provided list of values.
IS_NULL	Has no value.
LIKE	Has a value that matches the provided regular expression (strings only).
LT	Less than.
LTE	Less than or equal to.
NEQ	Not equal to.
NOT_NULL	Has any non-null value.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description of the property comparison operator.
String	getName()	Return the default name of the property comparison operator.
int	getOrdinal()	Return the numeric representation of the property comparison operator.
String	toString()	toString() JSON-style
static PropertyComparisonOperator	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PropertyComparisonOperator[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EQ

public static final PropertyComparisonOperator EQ

Equal to.

NEQ

public static final PropertyComparisonOperator NEQ

Not equal to.

LT

public static final PropertyComparisonOperator LT

Less than.

LTE

public static final PropertyComparisonOperator LTE

Less than or equal to.

GT

public static final PropertyComparisonOperator GT

Greater than.

GTE

public static final PropertyComparisonOperator GTE

Greater than or equal to.

IN

public static final PropertyComparisonOperator IN

Has a value of at least one in the provided list of values.

IS_NULL

public static final PropertyComparisonOperator IS_NULL

Has no value.

NOT_NULL

public static final PropertyComparisonOperator NOT_NULL

Has any non-null value.

LIKE

public static final PropertyComparisonOperator LIKE

Has a value that matches the provided regular expression (strings only).

Method Details

values

public static PropertyComparisonOperator[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PropertyComparisonOperator valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getOrdinal

public int getOrdinal()

Return the numeric representation of the property comparison operator.

Returns:

int ordinal

getName

public String getName()

Return the default name of the property comparison operator.

Returns:

String name

getDescription

public String getDescription()

Return the default description of the property comparison operator.

Returns:

String description

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<PropertyComparisonOperator>

Returns:

string description