org.elasticsearch.index.query

Class TermsFilterParser

java.lang.Object

org.elasticsearch.index.query.TermsFilterParser

All Implemented Interfaces:

FilterParser

public class TermsFilterParser
extends Object
implements FilterParser

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXECUTION_KEY
static String	EXECUTION_VALUE_AND
static String	EXECUTION_VALUE_AND_NOCACHE
static String	EXECUTION_VALUE_BOOL
static String	EXECUTION_VALUE_BOOL_NOCACHE
static String	EXECUTION_VALUE_FIELDDATA
static String	EXECUTION_VALUE_OR
static String	EXECUTION_VALUE_OR_NOCACHE
static String	EXECUTION_VALUE_PLAIN
static String	NAME

Constructor Summary

Constructors

Constructor and Description
TermsFilterParser()

Method Summary

Modifier and Type	Method and Description
String[]	names() The names this filter is registered under.
org.apache.lucene.search.Filter	parse(QueryParseContext parseContext) Parses the into a filter from the current parser location.
void	setIndicesTermsFilterCache(IndicesTermsFilterCache termsFilterCache)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

EXECUTION_KEY

public static final String EXECUTION_KEY

See Also:

Constant Field Values

EXECUTION_VALUE_PLAIN

public static final String EXECUTION_VALUE_PLAIN

See Also:

Constant Field Values

EXECUTION_VALUE_FIELDDATA

public static final String EXECUTION_VALUE_FIELDDATA

See Also:

Constant Field Values

EXECUTION_VALUE_BOOL

public static final String EXECUTION_VALUE_BOOL

See Also:

Constant Field Values

EXECUTION_VALUE_BOOL_NOCACHE

public static final String EXECUTION_VALUE_BOOL_NOCACHE

See Also:

Constant Field Values

EXECUTION_VALUE_AND

public static final String EXECUTION_VALUE_AND

See Also:

Constant Field Values

EXECUTION_VALUE_AND_NOCACHE

public static final String EXECUTION_VALUE_AND_NOCACHE

See Also:

Constant Field Values

EXECUTION_VALUE_OR

public static final String EXECUTION_VALUE_OR

See Also:

Constant Field Values

EXECUTION_VALUE_OR_NOCACHE

public static final String EXECUTION_VALUE_OR_NOCACHE

See Also:

Constant Field Values

Constructor Detail

TermsFilterParser

@Inject
public TermsFilterParser()

Method Detail

names

public String[] names()

Description copied from interface: FilterParser

The names this filter is registered under.

Specified by:

names in interface FilterParser

setIndicesTermsFilterCache

@Inject(optional=true)
public void setIndicesTermsFilterCache(IndicesTermsFilterCache termsFilterCache)

parse

public org.apache.lucene.search.Filter parse(QueryParseContext parseContext)
                                      throws IOException,
                                             QueryParsingException

Description copied from interface: FilterParser

Parses the into a filter from the current parser location. Will be at "START_OBJECT" location, and should end when the token is at the matching "END_OBJECT".

The parser should return null value when it should be ignored, regardless under which context it is. For example, an and filter with "and []" (no clauses), should be ignored regardless if it exists within a must clause or a must_not bool clause (that is why returning MATCH_ALL will not be good, since it will not match anything when returned within a must_not clause).

Specified by:

parse in interface FilterParser

Throws:

IOException

QueryParsingException