/*
* Licensed to ElasticSearch and Shay Banon 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.search.facet.histogram;
import com.google.common.collect.Maps;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.index.query.FilterBuilder;
import org.elasticsearch.search.builder.SearchSourceBuilderException;
import org.elasticsearch.search.facet.AbstractFacetBuilder;
import java.io.IOException;
import java.util.Map;
/**
*
*/
public class HistogramScriptFacetBuilder extends AbstractFacetBuilder {
private String lang;
private String keyFieldName;
private String keyScript;
private String valueScript;
private Map<String, Object> params;
private long interval = -1;
private HistogramFacet.ComparatorType comparatorType;
private Object from;
private Object to;
public HistogramScriptFacetBuilder(String name) {
super(name);
}
/**
* The language of the script.
*/
public HistogramScriptFacetBuilder lang(String lang) {
this.lang = lang;
return this;
}
public HistogramScriptFacetBuilder keyField(String keyFieldName) {
this.keyFieldName = keyFieldName;
return this;
}
public HistogramScriptFacetBuilder keyScript(String keyScript) {
this.keyScript = keyScript;
return this;
}
public HistogramScriptFacetBuilder valueScript(String valueScript) {
this.valueScript = valueScript;
return this;
}
public HistogramScriptFacetBuilder interval(long interval) {
this.interval = interval;
return this;
}
public HistogramScriptFacetBuilder param(String name, Object value) {
if (params == null) {
params = Maps.newHashMap();
}
params.put(name, value);
return this;
}
public HistogramScriptFacetBuilder comparator(HistogramFacet.ComparatorType comparatorType) {
this.comparatorType = comparatorType;
return this;
}
/**
* Marks the facet to run in a global scope, not bounded by any query.
*/
@Override
public HistogramScriptFacetBuilder global(boolean global) {
super.global(global);
return this;
}
/**
* Marks the facet to run in a specific scope.
*/
@Override
public HistogramScriptFacetBuilder scope(String scope) {
super.scope(scope);
return this;
}
/**
* Sets the bounds from and to for the facet. Both performs bounds check and includes only
* values within the bounds, and improves performance.
*/
public HistogramScriptFacetBuilder bounds(Object from, Object to) {
this.from = from;
this.to = to;
return this;
}
public HistogramScriptFacetBuilder facetFilter(FilterBuilder filter) {
this.facetFilter = filter;
return this;
}
/**
* Sets the nested path the facet will execute on. A match (root object) will then cause all the
* nested objects matching the path to be computed into the facet.
*/
public HistogramScriptFacetBuilder nested(String nested) {
this.nested = nested;
return this;
}
@Override
public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
if (keyScript == null && keyFieldName == null) {
throw new SearchSourceBuilderException("key_script or key_field must be set on histogram script facet for facet [" + name + "]");
}
if (valueScript == null) {
throw new SearchSourceBuilderException("value_script must be set on histogram script facet for facet [" + name + "]");
}
builder.startObject(name);
builder.startObject(HistogramFacet.TYPE);
if (keyFieldName != null) {
builder.field("key_field", keyFieldName);
} else if (keyScript != null) {
builder.field("key_script", keyScript);
}
builder.field("value_script", valueScript);
if (from != null && to != null) {
builder.field("from", from);
builder.field("to", to);
}
if (lang != null) {
builder.field("lang", lang);
}
if (interval > 0) { // interval is optional in script facet, can be defined by the key script
builder.field("interval", interval);
}
if (this.params != null) {
builder.field("params", this.params);
}
if (comparatorType != null) {
builder.field("comparator", comparatorType.description());
}
builder.endObject();
addFilterFacetAndGlobal(builder, params);
builder.endObject();
return builder;
}
}