org.elasticsearch.search.facet.datehistogram.DateHistogramFacetBuilder Maven / Gradle / Ivy
/*
* 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.datehistogram;
import com.google.common.collect.Maps;
import org.elasticsearch.common.unit.TimeValue;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.index.query.FilterBuilder;
import org.elasticsearch.search.builder.SearchSourceBuilderException;
import org.elasticsearch.search.facet.FacetBuilder;
import java.io.IOException;
import java.util.Map;
/**
* A facet builder of date histogram facets.
*/
public class DateHistogramFacetBuilder extends FacetBuilder {
private String keyFieldName;
private String valueFieldName;
private String interval = null;
private String preZone = null;
private String postZone = null;
private Boolean preZoneAdjustLargeInterval;
long preOffset = 0;
long postOffset = 0;
float factor = 1.0f;
private DateHistogramFacet.ComparatorType comparatorType;
private String valueScript;
private Map params;
private String lang;
/**
* Constructs a new date histogram facet with the provided facet logical name.
*
* @param name The logical name of the facet
*/
public DateHistogramFacetBuilder(String name) {
super(name);
}
/**
* The field name to perform the histogram facet. Translates to perform the histogram facet
* using the provided field as both the {@link #keyField(String)} and {@link #valueField(String)}.
*/
public DateHistogramFacetBuilder field(String field) {
this.keyFieldName = field;
return this;
}
/**
* The field name to use in order to control where the hit will "fall into" within the histogram
* entries. Essentially, using the key field numeric value, the hit will be "rounded" into the relevant
* bucket controlled by the interval.
*/
public DateHistogramFacetBuilder keyField(String keyField) {
this.keyFieldName = keyField;
return this;
}
/**
* The field name to use as the value of the hit to compute data based on values within the interval
* (for example, total).
*/
public DateHistogramFacetBuilder valueField(String valueField) {
this.valueFieldName = valueField;
return this;
}
public DateHistogramFacetBuilder valueScript(String valueScript) {
this.valueScript = valueScript;
return this;
}
public DateHistogramFacetBuilder param(String name, Object value) {
if (params == null) {
params = Maps.newHashMap();
}
params.put(name, value);
return this;
}
/**
* The language of the value script.
*/
public DateHistogramFacetBuilder lang(String lang) {
this.lang = lang;
return this;
}
/**
* The interval used to control the bucket "size" where each key value of a hit will fall into. Check
* the docs for all available values.
*/
public DateHistogramFacetBuilder interval(String interval) {
this.interval = interval;
return this;
}
/**
* Should pre zone be adjusted for large (day and above) intervals. Defaults to false.
*/
public DateHistogramFacetBuilder preZoneAdjustLargeInterval(boolean preZoneAdjustLargeInterval) {
this.preZoneAdjustLargeInterval = preZoneAdjustLargeInterval;
return this;
}
/**
* Sets the pre time zone to use when bucketing the values. This timezone will be applied before
* rounding off the result.
*
* Can either be in the form of "-10:00" or
* one of the values listed here: http://joda-time.sourceforge.net/timezones.html.
*/
public DateHistogramFacetBuilder preZone(String preZone) {
this.preZone = preZone;
return this;
}
/**
* Sets the post time zone to use when bucketing the values. This timezone will be applied after
* rounding off the result.
*
* Can either be in the form of "-10:00" or
* one of the values listed here: http://joda-time.sourceforge.net/timezones.html.
*/
public DateHistogramFacetBuilder postZone(String postZone) {
this.postZone = postZone;
return this;
}
/**
* Sets a pre offset that will be applied before rounding the results.
*/
public DateHistogramFacetBuilder preOffset(TimeValue preOffset) {
this.preOffset = preOffset.millis();
return this;
}
/**
* Sets a post offset that will be applied after rounding the results.
*/
public DateHistogramFacetBuilder postOffset(TimeValue postOffset) {
this.postOffset = postOffset.millis();
return this;
}
/**
* Sets the factor that will be used to multiply the value with before and divided
* by after the rounding of the results.
*/
public DateHistogramFacetBuilder factor(float factor) {
this.factor = factor;
return this;
}
public DateHistogramFacetBuilder comparator(DateHistogramFacet.ComparatorType comparatorType) {
this.comparatorType = comparatorType;
return this;
}
/**
* Should the facet run in global mode (not bounded by the search query) or not (bounded by
* the search query). Defaults to false.
*/
@Override
public DateHistogramFacetBuilder global(boolean global) {
super.global(global);
return this;
}
/**
* An additional filter used to further filter down the set of documents the facet will run on.
*/
@Override
public DateHistogramFacetBuilder 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 DateHistogramFacetBuilder nested(String nested) {
this.nested = nested;
return this;
}
@Override
public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
if (keyFieldName == null) {
throw new SearchSourceBuilderException("field must be set on date histogram facet for facet [" + name + "]");
}
if (interval == null) {
throw new SearchSourceBuilderException("interval must be set on date histogram facet for facet [" + name + "]");
}
builder.startObject(name);
builder.startObject(DateHistogramFacet.TYPE);
if (valueFieldName != null) {
builder.field("key_field", keyFieldName);
builder.field("value_field", valueFieldName);
} else {
builder.field("field", keyFieldName);
}
if (valueScript != null) {
builder.field("value_script", valueScript);
if (lang != null) {
builder.field("lang", lang);
}
if (this.params != null) {
builder.field("params", this.params);
}
}
builder.field("interval", interval);
if (preZone != null) {
builder.field("pre_zone", preZone);
}
if (preZoneAdjustLargeInterval != null) {
builder.field("pre_zone_adjust_large_interval", preZoneAdjustLargeInterval);
}
if (postZone != null) {
builder.field("post_zone", postZone);
}
if (preOffset != 0) {
builder.field("pre_offset", preOffset);
}
if (postOffset != 0) {
builder.field("post_offset", postOffset);
}
if (factor != 1.0f) {
builder.field("factor", factor);
}
if (comparatorType != null) {
builder.field("comparator", comparatorType.description());
}
builder.endObject();
addFilterFacetAndGlobal(builder, params);
builder.endObject();
return builder;
}
}