Package org.ametys.cms.search.query

Enum Query.Operator

java.lang.Object

java.lang.Enum<Query.Operator>

org.ametys.cms.search.query.Query.Operator

All Implemented Interfaces:

Serializable, Comparable<Query.Operator>

Enclosing interface:

Query

public static enum Query.Operator
extends Enum<Query.Operator>

Enumeration of available operators in Query

Enum Constant Summary

Enum Constants

Enum Constant	Description
EQ	Constant of test's operator for 'equals to' comparison
EXISTS	Operator testing the existence of a property.
FUZZY	Constant of test's operator for fuzzy search.
GE	Constant of test's operator for 'greater than or equals to' comparison
GT	Constant of test's operator for 'greater than' comparison
LE	Constant of test's operator for 'less than or equals to' comparison
LIKE	Constant of test's operator for 'like' comparison.
LT	Constant of test's operator for 'less than' comparison
NE	Constant of test's operator for 'not equals to' comparison
SEARCH	Constant of test's operator for textual search, on unstemmed terms.
SEARCH_STEMMED	Constant of test's operator for textual search, on stemmed terms.

Method Summary

Modifier and Type	Method	Description
static Query.Operator	fromName(String name)	Get an Operator object from its name.
String	getName()	Get the operator name.
static Query.Operator	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Query.Operator[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EXISTS

public static final Query.Operator EXISTS

Operator testing the existence of a property.

SEARCH

public static final Query.Operator SEARCH

Constant of test's operator for textual search, on unstemmed terms. Works only for type String

SEARCH_STEMMED

public static final Query.Operator SEARCH_STEMMED

Constant of test's operator for textual search, on stemmed terms. Works only for type String

LIKE

public static final Query.Operator LIKE

Constant of test's operator for 'like' comparison. Works only for type String

FUZZY

public static final Query.Operator FUZZY

Constant of test's operator for fuzzy search. Works only for type String

LT

public static final Query.Operator LT

Constant of test's operator for 'less than' comparison

LE

public static final Query.Operator LE

Constant of test's operator for 'less than or equals to' comparison

GT

public static final Query.Operator GT

Constant of test's operator for 'greater than' comparison

GE

public static final Query.Operator GE

Constant of test's operator for 'greater than or equals to' comparison

EQ

public static final Query.Operator EQ

Constant of test's operator for 'equals to' comparison

NE

public static final Query.Operator NE

Constant of test's operator for 'not equals to' comparison

Method Detail

values

public static Query.Operator[] 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 (Query.Operator c : Query.Operator.values())
    System.out.println(c);

Returns:

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

valueOf

public static Query.Operator valueOf(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:

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

NullPointerException - if the argument is null

getName

public String getName()

Get the operator name.

Returns:

the operator name.

fromName

public static Query.Operator fromName(String name)

Get an Operator object from its name.

Parameters:

name - the operator name.

Returns:

the operator object, or null if not found.