org.elasticsearch.index.query

クラス TemplateQueryParser

java.lang.Object

org.elasticsearch.index.query.TemplateQueryParser

すべての実装されたインタフェース:

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.

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static String	NAME Name to reference this type of query.
static String	QUERY Name of query parameter containing the template string.

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
TemplateQueryParser(ScriptService scriptService)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
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)

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

NAME

public static final String NAME

Name to reference this type of query.

関連項目:

定数フィールド値

QUERY

public static final String QUERY

Name of query parameter containing the template string.

関連項目:

定数フィールド値

コンストラクタの詳細

TemplateQueryParser

@Inject
public TemplateQueryParser(ScriptService scriptService)

メソッドの詳細

names

public String[] names()

インタフェースからコピーされた説明: QueryParser

The names this query parser is registered under.

定義:

names インタフェース内 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.

定義:

parse インタフェース内 QueryParser

パラメータ:

parseContext - parse context containing the templated query.

例外:

IOException

parse

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

例外:

IOException

parse

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

例外:

IOException

parse

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

例外:

IOException

parse

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

例外:

IOException