org.elasticsearch.index.query

Class TemplateQueryParser

java.lang.Object

org.elasticsearch.index.query.TemplateQueryParser

All Implemented Interfaces:

QueryParser

public class TemplateQueryParser
extends Object
implements QueryParser

In the simplest case, parse template string and variables from the request, compile the template and execute the template against the given variables.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Name to reference this type of query.
static String	QUERY Name of query parameter containing the template string.

Constructor Summary

Constructors

Constructor and Description
TemplateQueryParser(ScriptService scriptService)

Method Summary

Methods

Modifier and Type	Method and Description
String[]	names() The names this query parser is registered under.
org.apache.lucene.search.Query	parse(QueryParseContext parseContext) Parses the template query replacing template parameters with provided values.
static Template	parse(String defaultLang, XContentParser parser, ParseFieldMatcher parseFieldMatcher, String... parameters)
static Template	parse(XContentParser parser, Map<String,ScriptService.ScriptType> parameterMap, ParseFieldMatcher parseFieldMatcher)
static Template	parse(XContentParser parser, ParseFieldMatcher parseFieldMatcher)
static Template	parse(XContentParser parser, ParseFieldMatcher parseFieldMatcher, String... parameters)

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

Name to reference this type of query.

See Also:

Constant Field Values

QUERY

public static final String QUERY

Name of query parameter containing the template string.

See Also:

Constant Field Values

Constructor Detail

TemplateQueryParser

@Inject
public TemplateQueryParser(ScriptService scriptService)

Method Detail

names

public String[] names()

Description copied from interface: QueryParser

The names this query parser is registered under.

Specified by:

names in interface QueryParser

parse

@Nullable
public org.apache.lucene.search.Query parse(QueryParseContext parseContext)
                                     throws IOException

Parses the template query replacing template parameters with provided values. Handles both submitting the template as part of the request as well as referencing only the template name.

Specified by:

parse in interface QueryParser

Parameters:

parseContext - parse context containing the templated query.

Throws:

IOException

parse

public static Template parse(XContentParser parser,
             ParseFieldMatcher parseFieldMatcher,
             String... parameters)
                      throws IOException

Throws:

IOException

parse

public static Template parse(String defaultLang,
             XContentParser parser,
             ParseFieldMatcher parseFieldMatcher,
             String... parameters)
                      throws IOException

Throws:

IOException

parse

public static Template parse(XContentParser parser,
             ParseFieldMatcher parseFieldMatcher)
                      throws IOException

Throws:

IOException

parse

public static Template parse(XContentParser parser,
             Map<String,ScriptService.ScriptType> parameterMap,
             ParseFieldMatcher parseFieldMatcher)
                      throws IOException

Throws:

IOException