From dcfc7cead092563c4698d9d3331462f6f115f31e Mon Sep 17 00:00:00 2001 From: Isabel Drost-Fromm Date: Thu, 20 Mar 2014 17:58:27 +0100 Subject: [PATCH] Add some more documentation to TemplateQueryParser Relates to #4879 --- .../org/elasticsearch/index/query/TemplateQueryParser.java | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/main/java/org/elasticsearch/index/query/TemplateQueryParser.java b/src/main/java/org/elasticsearch/index/query/TemplateQueryParser.java index 1755da34aa9..b92a56cde08 100644 --- a/src/main/java/org/elasticsearch/index/query/TemplateQueryParser.java +++ b/src/main/java/org/elasticsearch/index/query/TemplateQueryParser.java @@ -56,6 +56,12 @@ public class TemplateQueryParser implements QueryParser { return new String[] {NAME}; } + /** + * 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. + * @param parseContext parse context containing the templated query. + */ @Override @Nullable public Query parse(QueryParseContext parseContext) throws IOException {