org.elasticsearch.search.sort.ScriptSortBuilder 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 subproject :server
/*
* Licensed to Elastic Search and Shay Banon under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. Elastic Search 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.search.sort;
import org.elasticsearch.common.collect.Maps;
import org.elasticsearch.common.xcontent.XContentBuilder;
import java.io.IOException;
import java.util.Map;
/**
* Script sort builder allows to sort based on a custom script expression.
*
* @author kimchy (shay.banon)
*/
public class ScriptSortBuilder extends SortBuilder {
private String lang;
private final String script;
private final String type;
private SortOrder order;
private Map params;
/**
* Constructs a script sort builder with the script and the type.
*
* @param script The script to use.
* @param type The type, can either be "string" or "number".
*/
public ScriptSortBuilder(String script, String type) {
this.script = script;
this.type = type;
}
/**
* Adds a parameter to the script.
*
* @param name The name of the parameter.
* @param value The value of the parameter.
*/
public ScriptSortBuilder param(String name, Object value) {
if (params == null) {
params = Maps.newHashMap();
}
params.put(name, value);
return this;
}
/**
* Sets the sort order.
*/
public ScriptSortBuilder order(SortOrder order) {
this.order = order;
return this;
}
/**
* The language of the script.
*/
public ScriptSortBuilder lang(String lang) {
this.lang = lang;
return this;
}
@Override public void toXContent(XContentBuilder builder, Params params) throws IOException {
builder.startObject("_script");
builder.field("script", script);
builder.field("type", type);
if (order == SortOrder.DESC) {
builder.field("reverse", true);
}
if (this.params != null) {
builder.field("params", this.params);
}
builder.endObject();
}
}