Package com.ibm.watson.discovery.query

Enum Operator

java.lang.Object

java.lang.Enum<Operator>

com.ibm.watson.discovery.query.Operator

All Implemented Interfaces:

Serializable, Comparable<Operator>, java.lang.constant.Constable

public enum Operator
extends Enum<Operator>

Query Language Operator Syntax.

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
AND	The and.
BOOST	The boost.
CLOSING_ARRAY	The closing array.
CLOSING_GROUPING	The closing grouping.
CONTAINS	The contains.
DOUBLE_QUOTE	The double quote.
EQUALS	The equals.
ESCAPE	The escape.
FIELD_SEPARATOR	The field separator.
FUZZY	The fuzzy.
GREATER_THAN	The greater than.
GREATER_THAN_OR_EQUAL_TO	The greater than or equal to.
LESS_THAN	The less than.
LESS_THAN_OR_EQUAL_TO	The less than or equal to.
NEST_AGGREGATION	The nest aggregation.
NOT	The not.
OPENING_ARRAY	The opening array.
OPENING_GROUPING	The opening grouping.
OR	The or.
WILDCARD	The wildcard.

Method Summary

Modifier and Type	Method	Description
String	getSymbol()	Gets the symbol.
boolean	shouldEscape()	Should escape.
String	toString()	To string.
static Operator	valueOf(String name)	Returns the enum constant of this type with the specified name.
static 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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FIELD_SEPARATOR

public static final Operator FIELD_SEPARATOR

The field separator.

EQUALS

public static final Operator EQUALS

The equals.

CONTAINS

public static final Operator CONTAINS

The contains.

ESCAPE

public static final Operator ESCAPE

The escape.

FUZZY

public static final Operator FUZZY

The fuzzy.

OR

public static final Operator OR

The or.

AND

public static final Operator AND

The and.

NOT

public static final Operator NOT

The not.

NEST_AGGREGATION

public static final Operator NEST_AGGREGATION

The nest aggregation.

LESS_THAN

public static final Operator LESS_THAN

The less than.

LESS_THAN_OR_EQUAL_TO

public static final Operator LESS_THAN_OR_EQUAL_TO

The less than or equal to.

GREATER_THAN

public static final Operator GREATER_THAN

The greater than.

GREATER_THAN_OR_EQUAL_TO

public static final Operator GREATER_THAN_OR_EQUAL_TO

The greater than or equal to.

BOOST

public static final Operator BOOST

The boost.

WILDCARD

public static final Operator WILDCARD

The wildcard.

OPENING_GROUPING

public static final Operator OPENING_GROUPING

The opening grouping.

CLOSING_GROUPING

public static final Operator CLOSING_GROUPING

The closing grouping.

OPENING_ARRAY

public static final Operator OPENING_ARRAY

The opening array.

CLOSING_ARRAY

public static final Operator CLOSING_ARRAY

The closing array.

DOUBLE_QUOTE

public static final Operator DOUBLE_QUOTE

The double quote.

Method Details

values

public static Operator[] values()

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

Returns:

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

valueOf

public static 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

getSymbol

public String getSymbol()

Gets the symbol.

Returns:

the symbol

shouldEscape

public boolean shouldEscape()

Should escape.

Returns:

true, if successful

toString

public String toString()

To string.

Overrides:

toString in class Enum<Operator>

Returns:

the string