org.elasticsearch.index.query.TemplateQueryBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Show all versions of elasticsearch Show documentation
Elasticsearch - Open Source, Distributed, RESTful Search Engine
/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.elasticsearch.index.query;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.script.ScriptService;
import org.elasticsearch.script.Template;
import java.io.IOException;
import java.util.Map;
/**
* Facilitates creating template query requests.
* */
public class TemplateQueryBuilder extends QueryBuilder {
/** Template to fill. */
private Template template;
/** Parameters to fill the template with. */
private Map vars;
/** Template to fill.*/
private String templateString;
private ScriptService.ScriptType templateType;
/**
* @param template
* the template to use for that query.
* */
public TemplateQueryBuilder(Template template) {
this.template = template;
}
/**
* @param template
* the template to use for that query.
* @param vars
* the parameters to fill the template with.
* @deprecated Use {@link #TemplateQueryBuilder(Template)} instead.
* */
@Deprecated
public TemplateQueryBuilder(String template, Map vars) {
this(template, ScriptService.ScriptType.INLINE, vars);
}
/**
* @param template
* the template to use for that query.
* @param vars
* the parameters to fill the template with.
* @param templateType
* what kind of template (INLINE,FILE,ID)
* @deprecated Use {@link #TemplateQueryBuilder(Template)} instead.
* */
@Deprecated
public TemplateQueryBuilder(String template, ScriptService.ScriptType templateType, Map vars) {
this.templateString = template;
this.vars = vars;
this.templateType = templateType;
}
@Override
protected void doXContent(XContentBuilder builder, Params builderParams) throws IOException {
builder.field(TemplateQueryParser.NAME);
if (template == null) {
new Template(templateString, templateType, null, null, this.vars).toXContent(builder, builderParams);
} else {
template.toXContent(builder, builderParams);
}
}
}