org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder 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 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.search.aggregations.support;
import org.elasticsearch.Version;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.time.DateUtils;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.index.query.QueryShardContext;
import org.elasticsearch.script.Script;
import org.elasticsearch.search.aggregations.AbstractAggregationBuilder;
import org.elasticsearch.search.aggregations.AggregationInitializationException;
import org.elasticsearch.search.aggregations.AggregatorFactories.Builder;
import org.elasticsearch.search.aggregations.AggregatorFactory;
import java.io.IOException;
import java.time.ZoneId;
import java.util.Map;
import java.util.Objects;
public abstract class ValuesSourceAggregationBuilder>
extends AbstractAggregationBuilder {
public abstract static class LeafOnly>
extends ValuesSourceAggregationBuilder {
protected LeafOnly(String name, ValuesSourceType valuesSourceType, ValueType targetValueType) {
super(name, valuesSourceType, targetValueType);
}
protected LeafOnly(LeafOnly clone, Builder factoriesBuilder, Map metaData) {
super(clone, factoriesBuilder, metaData);
if (factoriesBuilder.count() > 0) {
throw new AggregationInitializationException("Aggregator [" + name + "] of type ["
+ getType() + "] cannot accept sub-aggregations");
}
}
/**
* Read an aggregation from a stream that does not serialize its targetValueType. This should be used by most subclasses.
*/
protected LeafOnly(StreamInput in, ValuesSourceType valuesSourceType, ValueType targetValueType) throws IOException {
super(in, valuesSourceType, targetValueType);
}
/**
* Read an aggregation from a stream that serializes its targetValueType. This should only be used by subclasses that override
* {@link #serializeTargetValueType(Version)} to return true.
*/
protected LeafOnly(StreamInput in, ValuesSourceType valuesSourceType) throws IOException {
super(in, valuesSourceType);
}
@Override
public final AB subAggregations(Builder subFactories) {
throw new AggregationInitializationException("Aggregator [" + name + "] of type ["
+ getType() + "] cannot accept sub-aggregations");
}
}
private final ValuesSourceType valuesSourceType;
private final ValueType targetValueType;
private String field = null;
private Script script = null;
private ValueType valueType = null;
private String format = null;
private Object missing = null;
private ZoneId timeZone = null;
protected ValuesSourceConfig config;
protected ValuesSourceAggregationBuilder(String name, ValuesSourceType valuesSourceType, ValueType targetValueType) {
super(name);
if (valuesSourceType == null) {
throw new IllegalArgumentException("[valuesSourceType] must not be null: [" + name + "]");
}
this.valuesSourceType = valuesSourceType;
this.targetValueType = targetValueType;
}
protected ValuesSourceAggregationBuilder(ValuesSourceAggregationBuilder clone,
Builder factoriesBuilder, Map metaData) {
super(clone, factoriesBuilder, metaData);
this.valuesSourceType = clone.valuesSourceType;
this.targetValueType = clone.targetValueType;
this.field = clone.field;
this.valueType = clone.valueType;
this.format = clone.format;
this.missing = clone.missing;
this.timeZone = clone.timeZone;
this.config = clone.config;
this.script = clone.script;
}
/**
* Read an aggregation from a stream that has a sensible default for TargetValueType. This should be used by most subclasses.
* Subclasses needing to maintain backward compatibility to a version that did not serialize TargetValueType should use this
* constructor, providing the old, constant value for TargetValueType and override {@link #serializeTargetValueType(Version)} to return
* true only for versions that support the serialization.
*/
protected ValuesSourceAggregationBuilder(StreamInput in, ValuesSourceType valuesSourceType, ValueType targetValueType)
throws IOException {
super(in);
this.valuesSourceType = valuesSourceType;
if (serializeTargetValueType(in.getVersion())) {
this.targetValueType = in.readOptionalWriteable(ValueType::readFromStream);
} else {
this.targetValueType = targetValueType;
}
read(in);
}
/**
* Read an aggregation from a stream that serializes its targetValueType. This should only be used by subclasses that override
* {@link #serializeTargetValueType(Version)} to return true.
*/
protected ValuesSourceAggregationBuilder(StreamInput in, ValuesSourceType valuesSourceType) throws IOException {
super(in);
// TODO: Can we get rid of this constructor and always use the three value version? Does this assert provide any value?
assert serializeTargetValueType(in.getVersion()) : "Wrong read constructor called for subclass that serializes its targetValueType";
this.valuesSourceType = valuesSourceType;
this.targetValueType = in.readOptionalWriteable(ValueType::readFromStream);
read(in);
}
/**
* Read from a stream.
*/
private void read(StreamInput in) throws IOException {
field = in.readOptionalString();
if (in.readBoolean()) {
script = new Script(in);
}
if (in.readBoolean()) {
valueType = ValueType.readFromStream(in);
}
format = in.readOptionalString();
missing = in.readGenericValue();
if (in.getVersion().before(Version.V_7_0_0)) {
timeZone = DateUtils.dateTimeZoneToZoneId(in.readOptionalTimeZone());
} else {
timeZone = in.readOptionalZoneId();
}
}
@Override
protected final void doWriteTo(StreamOutput out) throws IOException {
if (serializeTargetValueType(out.getVersion())) {
out.writeOptionalWriteable(targetValueType);
}
out.writeOptionalString(field);
boolean hasScript = script != null;
out.writeBoolean(hasScript);
if (hasScript) {
script.writeTo(out);
}
boolean hasValueType = valueType != null;
out.writeBoolean(hasValueType);
if (hasValueType) {
valueType.writeTo(out);
}
out.writeOptionalString(format);
out.writeGenericValue(missing);
if (out.getVersion().before(Version.V_7_0_0)) {
out.writeOptionalTimeZone(DateUtils.zoneIdToDateTimeZone(timeZone));
} else {
out.writeOptionalZoneId(timeZone);
}
innerWriteTo(out);
}
/**
* Write subclass's state to the stream.
*/
protected abstract void innerWriteTo(StreamOutput out) throws IOException;
/**
* Should this builder serialize its targetValueType? Defaults to false. All subclasses that override this to true should use the three
* argument read constructor rather than the four argument version.
* @param version For backwards compatibility, subclasses can change behavior based on the version
*/
protected boolean serializeTargetValueType(Version version) {
return false;
}
/**
* Sets the field to use for this aggregation.
*/
@SuppressWarnings("unchecked")
public AB field(String field) {
if (field == null) {
throw new IllegalArgumentException("[field] must not be null: [" + name + "]");
}
this.field = field;
return (AB) this;
}
/**
* Gets the field to use for this aggregation.
*/
public String field() {
return field;
}
/**
* Sets the script to use for this aggregation.
*/
@SuppressWarnings("unchecked")
public AB script(Script script) {
if (script == null) {
throw new IllegalArgumentException("[script] must not be null: [" + name + "]");
}
this.script = script;
return (AB) this;
}
/**
* Gets the script to use for this aggregation.
*/
public Script script() {
return script;
}
/**
* Sets the {@link ValueType} for the value produced by this aggregation
*/
@SuppressWarnings("unchecked")
public AB valueType(ValueType valueType) {
if (valueType == null) {
throw new IllegalArgumentException("[valueType] must not be null: [" + name + "]");
}
this.valueType = valueType;
return (AB) this;
}
/**
* Gets the {@link ValueType} for the value produced by this aggregation
*/
public ValueType valueType() {
return valueType;
}
/**
* Sets the format to use for the output of the aggregation.
*/
@SuppressWarnings("unchecked")
public AB format(String format) {
if (format == null) {
throw new IllegalArgumentException("[format] must not be null: [" + name + "]");
}
this.format = format;
return (AB) this;
}
/**
* Gets the format to use for the output of the aggregation.
*/
public String format() {
return format;
}
/**
* Sets the value to use when the aggregation finds a missing value in a
* document
*/
@SuppressWarnings("unchecked")
public AB missing(Object missing) {
if (missing == null) {
throw new IllegalArgumentException("[missing] must not be null: [" + name + "]");
}
this.missing = missing;
return (AB) this;
}
/**
* Gets the value to use when the aggregation finds a missing value in a
* document
*/
public Object missing() {
return missing;
}
/**
* Sets the time zone to use for this aggregation
*/
@SuppressWarnings("unchecked")
public AB timeZone(ZoneId timeZone) {
if (timeZone == null) {
throw new IllegalArgumentException("[timeZone] must not be null: [" + name + "]");
}
this.timeZone = timeZone;
return (AB) this;
}
/**
* Gets the time zone to use for this aggregation
*/
public ZoneId timeZone() {
return timeZone;
}
@Override
protected final ValuesSourceAggregatorFactory doBuild(QueryShardContext queryShardContext, AggregatorFactory parent,
Builder subFactoriesBuilder) throws IOException {
ValuesSourceConfig config = resolveConfig(queryShardContext);
ValuesSourceAggregatorFactory factory = innerBuild(queryShardContext, config, parent, subFactoriesBuilder);
return factory;
}
/**
* Provide a hook for aggregations to have finer grained control of the CoreValuesSourceType for script values. This will only be
* called if the user did not supply a type hint for the script. The script object is provided for reference.
*
* @param script - The user supplied script
* @return The CoreValuesSourceType we expect this script to yield.
*/
protected ValuesSourceType resolveScriptAny(Script script) {
return CoreValuesSourceType.BYTES;
}
/**
* Provide a hook for aggregations to have finer grained control of the ValueType for script values. This will only be called if the
* user did not supply a type hint for the script. The script object is provided for reference
* @param script - the user supplied script
* @return The ValueType we expect this script to yield
*/
protected ValueType defaultValueType(Script script) {
return valueType;
}
protected ValuesSourceConfig resolveConfig(QueryShardContext queryShardContext) {
ValueType valueType = this.valueType != null ? this.valueType : targetValueType;
return ValuesSourceConfig.resolve(queryShardContext,
valueType, field, script, missing, timeZone, format, this::resolveScriptAny);
}
protected abstract ValuesSourceAggregatorFactory innerBuild(QueryShardContext queryShardContext,
ValuesSourceConfig config,
AggregatorFactory parent,
Builder subFactoriesBuilder) throws IOException;
@Override
public final XContentBuilder internalXContent(XContentBuilder builder, Params params) throws IOException {
builder.startObject();
if (field != null) {
builder.field("field", field);
}
if (script != null) {
builder.field("script", script);
}
if (missing != null) {
builder.field("missing", missing);
}
if (format != null) {
builder.field("format", format);
}
if (timeZone != null) {
builder.field("time_zone", timeZone.toString());
}
if (valueType != null) {
builder.field("value_type", valueType.getPreferredName());
}
doXContentBody(builder, params);
builder.endObject();
return builder;
}
protected abstract XContentBuilder doXContentBody(XContentBuilder builder, Params params) throws IOException;
@Override
public int hashCode() {
return Objects.hash(super.hashCode(), field, format, missing, script,
targetValueType, timeZone, valueType, valuesSourceType);
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null || getClass() != obj.getClass()) return false;
if (super.equals(obj) == false) return false;
ValuesSourceAggregationBuilder other = (ValuesSourceAggregationBuilder) obj;
return Objects.equals(valuesSourceType, other.valuesSourceType)
&& Objects.equals(field, other.field)
&& Objects.equals(format, other.format)
&& Objects.equals(missing, other.missing)
&& Objects.equals(script, other.script)
&& Objects.equals(targetValueType, other.targetValueType)
&& Objects.equals(timeZone, other.timeZone)
&& Objects.equals(valueType, other.valueType);
}
}