Package org.exoplatform.commons.search.es

Enum ElasticSearchFilterType

java.lang.Object

java.lang.Enum<ElasticSearchFilterType>

org.exoplatform.commons.search.es.ElasticSearchFilterType

All Implemented Interfaces:

Serializable, Comparable<ElasticSearchFilterType>

public enum ElasticSearchFilterType
extends Enum<ElasticSearchFilterType>

Filter type that can be added by search connectors in ES queries (seeElasticSearchServiceConnector#getAdditionalFilters(java.util.List)). Type FILTER_CUSTOM allows to define any type of filter by providing the full content of the filter.

Enum Constant Summary

Enum Constants

Enum Constant	Description
FILTER_BY_TERM
FILTER_CUSTOM
FILTER_EXIST
FILTER_NOT_EXIST

Method Summary

Modifier and Type	Method	Description
String	toString()
static ElasticSearchFilterType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ElasticSearchFilterType[]	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

FILTER_BY_TERM

public static final ElasticSearchFilterType FILTER_BY_TERM

FILTER_EXIST

public static final ElasticSearchFilterType FILTER_EXIST

FILTER_NOT_EXIST

public static final ElasticSearchFilterType FILTER_NOT_EXIST

FILTER_CUSTOM

public static final ElasticSearchFilterType FILTER_CUSTOM

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<ElasticSearchFilterType>