org.elasticsearch.index.query

Class TemplateQueryParser

java.lang.Object

org.elasticsearch.index.query.TemplateQueryParser

All Implemented Interfaces:

QueryParser<TemplateQueryBuilder>

public class TemplateQueryParser
extends java.lang.Object
implements QueryParser<TemplateQueryBuilder>

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

Constructor Summary

Constructors

Constructor and Description
TemplateQueryParser()

Method Summary

Modifier and Type	Method and Description
TemplateQueryBuilder	fromXContent(QueryParseContext parseContext) Parses the template query replacing template parameters with provided values.
TemplateQueryBuilder	getBuilderPrototype()
java.lang.String[]	names() The names this query parser is registered under.
static Template	parse(java.lang.String defaultLang, XContentParser parser, ParseFieldMatcher parseFieldMatcher, java.lang.String... parameters)
static Template	parse(XContentParser parser, java.util.Map<java.lang.String,ScriptService.ScriptType> parameterMap, ParseFieldMatcher parseFieldMatcher)
static Template	parse(XContentParser parser, ParseFieldMatcher parseFieldMatcher)
static Template	parse(XContentParser parser, ParseFieldMatcher parseFieldMatcher, java.lang.String... parameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateQueryParser

public TemplateQueryParser()

Method Detail

names

public java.lang.String[] names()

Description copied from interface: QueryParser

The names this query parser is registered under.

Specified by:

names in interface QueryParser<TemplateQueryBuilder>

fromXContent

@Nullable
public TemplateQueryBuilder fromXContent(QueryParseContext parseContext)
                                            throws java.io.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:

fromXContent in interface QueryParser<TemplateQueryBuilder>

Parameters:

parseContext - parse context containing the templated query.

Returns:

the new QueryBuilder

Throws:

java.io.IOException

parse

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

Throws:

java.io.IOException

parse

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

Throws:

java.io.IOException

parse

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

Throws:

java.io.IOException

parse

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

Throws:

java.io.IOException

getBuilderPrototype

public TemplateQueryBuilder getBuilderPrototype()

Specified by:

getBuilderPrototype in interface QueryParser<TemplateQueryBuilder>

Returns:

an empty QueryBuilder instance for this parser that can be used for deserialization