Package org.gcube.informationsystem.resourceregistry.queries.operators

Enum Class ComparisonOperator

java.lang.Object

java.lang.Enum<ComparisonOperator>

org.gcube.informationsystem.resourceregistry.queries.operators.ComparisonOperator

All Implemented Interfaces:

Serializable, Comparable<ComparisonOperator>, Constable

public enum ComparisonOperator
extends Enum<ComparisonOperator>

Defines OrientDB comparison and collection operators used in JSON queries.

Author:

Luca Frosini (ISTI - CNR)

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
BETWEEN	Between operator.
CONTAINS	Collection contains operator.
CONTAINS_ALL	Collection contains all operator.
CONTAINS_ANY	Collection contains any operator.
CONTAINS_KEY	Map contains key operator.
CONTAINS_TEXT	Contains text operator.
CONTAINS_VALUE	Map contains value operator.
EQ	Equal operator.
GT	Greater than operator.
GTE	Greater than or equal operator.
IN	Collection membership operator.
IS	Is operator for NULL checks.
IS_DEFINED	Property is defined operator.
IS_NOT_DEFINED	Property is not defined operator.
LIKE	Like wildcard operator.
LT	Less than operator.
LTE	Less than or equal operator.
MATCHES	Regex matches operator.
NE	Not equal operator.

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.gcube.informationsystem.types.PropertyTypeName.BaseTypeGroup	allowed	The allowed value type group for operands.
protected final String	dbOperator	The underlying OrientDB database operator string.
protected final String	description	The human-readable description of the operator.
protected final int	numberOfOperand	The number of operands accepted by this operator.
protected final String	operatorKey	The unique query operator key string.

Method Summary

Modifier and Type	Method	Description
StringBuffer	addCondition(String... operands)	Builds a SQL condition from raw string operands.
StringBuffer	addCondition(org.gcube.com.fasterxml.jackson.databind.JsonNode jn, String fieldNamePrefix)	Builds a SQL condition from a JSON query node (subclass hook).
String	getDbOperator()	Returns the underlying OrientDB database operator string.
String	getDescription()	Returns the human-readable description of the operator.
static ComparisonOperator	getOperator(String key)	Resolves a ComparisonOperator by its key.
String	getOperatorKey()	Returns the unique query operator key string.
static Set<String>	getOperators()	Returns the set of all registered operator keys.
static String	getValue(org.gcube.com.fasterxml.jackson.databind.JsonNode jsonNode)	Formats and escapes a JSON node value as a SQL-safe literal.
static ComparisonOperator	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ComparisonOperator[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EQ

public static final ComparisonOperator EQ

Equal operator.

GT

public static final ComparisonOperator GT

Greater than operator.

GTE

public static final ComparisonOperator GTE

Greater than or equal operator.

LT

public static final ComparisonOperator LT

Less than operator.

LTE

public static final ComparisonOperator LTE

Less than or equal operator.

NE

public static final ComparisonOperator NE

Not equal operator.

BETWEEN

public static final ComparisonOperator BETWEEN

Between operator.

IS

public static final ComparisonOperator IS

Is operator for NULL checks.

LIKE

public static final ComparisonOperator LIKE

Like wildcard operator.

CONTAINS_TEXT

public static final ComparisonOperator CONTAINS_TEXT

Contains text operator.

MATCHES

public static final ComparisonOperator MATCHES

Regex matches operator.

IN

public static final ComparisonOperator IN

Collection membership operator.

CONTAINS

public static final ComparisonOperator CONTAINS

Collection contains operator.

CONTAINS_ALL

public static final ComparisonOperator CONTAINS_ALL

Collection contains all operator.

CONTAINS_ANY

public static final ComparisonOperator CONTAINS_ANY

Collection contains any operator.

CONTAINS_KEY

public static final ComparisonOperator CONTAINS_KEY

Map contains key operator.

CONTAINS_VALUE

public static final ComparisonOperator CONTAINS_VALUE

Map contains value operator.

IS_DEFINED

public static final ComparisonOperator IS_DEFINED

Property is defined operator.

IS_NOT_DEFINED

public static final ComparisonOperator IS_NOT_DEFINED

Property is not defined operator.

Field Details

operatorKey

protected final String operatorKey

The unique query operator key string.

numberOfOperand

protected final int numberOfOperand

The number of operands accepted by this operator.

dbOperator

protected final String dbOperator

The underlying OrientDB database operator string.

allowed

protected final org.gcube.informationsystem.types.PropertyTypeName.BaseTypeGroup allowed

The allowed value type group for operands.

description

protected final String description

The human-readable description of the operator.

Method Details

values

public static ComparisonOperator[] 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 ComparisonOperator 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

getOperatorKey

public String getOperatorKey()

Returns the unique query operator key string.

Returns:

the operator key string

getDbOperator

public String getDbOperator()

Returns the underlying OrientDB database operator string.

Returns:

the OrientDB database operator string

getDescription

public String getDescription()

Returns the human-readable description of the operator.

Returns:

the description string

getOperators

public static Set<String> getOperators()

Returns the set of all registered operator keys.

Returns:

the set of operator keys

getOperator

public static ComparisonOperator getOperator(String key)

Resolves a ComparisonOperator by its key.

Parameters:

key - the operator key

Returns:

the resolved ComparisonOperator, or null

addCondition

public StringBuffer addCondition(String... operands)

Builds a SQL condition from raw string operands.

Parameters:

operands - the operands

Returns:

a string buffer containing the formatted SQL condition

getValue

public static String getValue(org.gcube.com.fasterxml.jackson.databind.JsonNode jsonNode)

Formats and escapes a JSON node value as a SQL-safe literal.

Array nodes are formatted as an OrientDB collection literal (e.g. ["a", "b"]), each element individually escaped. Scalar nodes are formatted as a single literal.

Parameters:

jsonNode - the JSON value node

Returns:

the escaped SQL literal string

addCondition

public StringBuffer addCondition(org.gcube.com.fasterxml.jackson.databind.JsonNode jn,
 String fieldNamePrefix)

Builds a SQL condition from a JSON query node (subclass hook).

Parameters:

jn - the JSON query node

fieldNamePrefix - the parent field name prefix

Returns:

the formatted SQL condition