org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder Maven / Gradle / Ivy
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
package org.elasticsearch.search.aggregations.support;
import org.elasticsearch.TransportVersion;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
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 org.elasticsearch.xcontent.AbstractObjectParser;
import org.elasticsearch.xcontent.ObjectParser;
import org.elasticsearch.xcontent.ParseField;
import org.elasticsearch.xcontent.XContentBuilder;
import org.elasticsearch.xcontent.XContentParser;
import java.io.IOException;
import java.time.ZoneId;
import java.time.ZoneOffset;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
public abstract class ValuesSourceAggregationBuilder> extends AbstractAggregationBuilder {
public static void declareFields(
AbstractObjectParser, T> objectParser,
boolean scriptable,
boolean formattable,
boolean timezoneAware
) {
declareFields(objectParser, scriptable, formattable, timezoneAware, true);
}
public static void declareFields(
AbstractObjectParser, T> objectParser,
boolean scriptable,
boolean formattable,
boolean timezoneAware,
boolean fieldRequired
) {
objectParser.declareField(
ValuesSourceAggregationBuilder::field,
XContentParser::text,
ParseField.CommonFields.FIELD,
ObjectParser.ValueType.STRING
);
objectParser.declareField(
ValuesSourceAggregationBuilder::missing,
XContentParser::objectText,
ParseField.CommonFields.MISSING,
ObjectParser.ValueType.VALUE
);
objectParser.declareField(ValuesSourceAggregationBuilder::userValueTypeHint, p -> {
ValueType type = ValueType.lenientParse(p.text());
if (type == null) {
throw new IllegalArgumentException("Unknown value type [" + p.text() + "]");
}
return type;
}, ValueType.VALUE_TYPE, ObjectParser.ValueType.STRING);
if (formattable) {
objectParser.declareField(
ValuesSourceAggregationBuilder::format,
XContentParser::text,
ParseField.CommonFields.FORMAT,
ObjectParser.ValueType.STRING
);
}
if (scriptable) {
objectParser.declareField(
ValuesSourceAggregationBuilder::script,
(parser, context) -> Script.parse(parser),
Script.SCRIPT_PARSE_FIELD,
ObjectParser.ValueType.OBJECT_OR_STRING
);
if (fieldRequired) {
String[] fields = new String[] {
ParseField.CommonFields.FIELD.getPreferredName(),
Script.SCRIPT_PARSE_FIELD.getPreferredName() };
objectParser.declareRequiredFieldSet(fields);
}
} else {
if (fieldRequired) {
objectParser.declareRequiredFieldSet(ParseField.CommonFields.FIELD.getPreferredName());
}
}
if (timezoneAware) {
objectParser.declareField(ValuesSourceAggregationBuilder::timeZone, p -> {
if (p.currentToken() == XContentParser.Token.VALUE_STRING) {
return ZoneId.of(p.text());
} else {
return ZoneOffset.ofHours(p.intValue());
}
}, ParseField.CommonFields.TIME_ZONE, ObjectParser.ValueType.LONG);
}
}
public abstract static class LeafOnly> extends ValuesSourceAggregationBuilder {
protected LeafOnly(String name) {
super(name);
}
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
*/
protected LeafOnly(StreamInput in) throws IOException {
super(in);
}
@Override
public final AB subAggregations(Builder subFactories) {
throw new AggregationInitializationException(
"Aggregator [" + name + "] of type [" + getType() + "] cannot accept sub-aggregations"
);
}
@Override
public final BucketCardinality bucketCardinality() {
return BucketCardinality.NONE;
}
}
public abstract static class MetricsAggregationBuilder> extends LeafOnly {
protected MetricsAggregationBuilder(String name) {
super(name);
}
protected MetricsAggregationBuilder(LeafOnly clone, Builder factoriesBuilder, Map metadata) {
super(clone, factoriesBuilder, metadata);
}
protected MetricsAggregationBuilder(StreamInput in) throws IOException {
super(in);
}
/** Generated metrics from this aggregation that can be accessed via
* {@link org.elasticsearch.search.aggregations.InternalAggregation#getProperty(String)}*/
public abstract Set metricNames();
}
public abstract static class SingleMetricAggregationBuilder> extends
MetricsAggregationBuilder {
private static final Set METRIC_NAME = Set.of("value");
protected SingleMetricAggregationBuilder(String name) {
super(name);
}
protected SingleMetricAggregationBuilder(LeafOnly clone, Builder factoriesBuilder, Map metadata) {
super(clone, factoriesBuilder, metadata);
}
protected SingleMetricAggregationBuilder(StreamInput in) throws IOException {
super(in);
}
public Set metricNames() {
return METRIC_NAME;
}
}
private String field = null;
private Script script = null;
private ValueType userValueTypeHint = null;
private String format = null;
private Object missing = null;
private ZoneId timeZone = null;
protected ValuesSourceConfig config;
protected ValuesSourceAggregationBuilder(String name) {
super(name);
}
protected ValuesSourceAggregationBuilder(
ValuesSourceAggregationBuilder clone,
Builder factoriesBuilder,
Map metadata
) {
super(clone, factoriesBuilder, metadata);
this.field = clone.field;
this.userValueTypeHint = clone.userValueTypeHint;
this.format = clone.format;
this.missing = clone.missing;
this.timeZone = clone.timeZone;
this.config = clone.config;
this.script = clone.script;
}
/**
* Read from a stream.
*/
protected ValuesSourceAggregationBuilder(StreamInput in) throws IOException {
super(in);
if (serializeTargetValueType(in.getTransportVersion())) {
ValueType valueType = in.readOptionalWriteable(ValueType::readFromStream);
assert valueType == null;
}
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()) {
userValueTypeHint = ValueType.readFromStream(in);
}
format = in.readOptionalString();
missing = in.readGenericValue();
timeZone = in.readOptionalZoneId();
}
@Override
protected final void doWriteTo(StreamOutput out) throws IOException {
if (serializeTargetValueType(out.getTransportVersion())) {
// TODO: deprecate this so we don't need to carry around a useless null in the wire format
out.writeOptionalWriteable(null);
}
out.writeOptionalString(field);
boolean hasScript = script != null;
out.writeBoolean(hasScript);
if (hasScript) {
script.writeTo(out);
}
boolean hasValueType = userValueTypeHint != null;
out.writeBoolean(hasValueType);
if (hasValueType) {
userValueTypeHint.writeTo(out);
}
out.writeOptionalString(format);
out.writeGenericValue(missing);
out.writeOptionalZoneId(timeZone);
innerWriteTo(out);
}
/**
* Write subclass's state to the stream.
*/
protected abstract void innerWriteTo(StreamOutput out) throws IOException;
/**
* DO NOT OVERRIDE THIS!
*
* This method only exists for legacy support. No new aggregations need this, nor should they override it.
*
* @param version For backwards compatibility, subclasses can change behavior based on the version
*/
protected boolean serializeTargetValueType(TransportVersion 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;
}
/**
* This setter should only be used during parsing, to set the userValueTypeHint. This is information the user provides in the json
* query to indicate the output type of a script or the type of the 'missing' replacement value.
*
* @param valueType - The parsed {@link ValueType} based on the string the user specified
* @return - The modified builder instance, for chaining.
*/
@SuppressWarnings("unchecked")
public AB userValueTypeHint(ValueType valueType) {
if (valueType == null) {
// TODO: This is nonsense. We allow the value to be null (via constructor), but don't allow it to be set to null. This means
// thing looking to copy settings (like RollupRequestTranslator) need to check if userValueTypeHint is not null, and then
// set it if and only if it is non-null.
throw new IllegalArgumentException("[userValueTypeHint] must not be null: [" + name + "]");
}
this.userValueTypeHint = valueType;
return (AB) this;
}
public ValueType userValueTypeHint() {
return userValueTypeHint;
}
/**
* 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(AggregationContext context, AggregatorFactory parent, Builder subFactoriesBuilder)
throws IOException {
ValuesSourceConfig config = resolveConfig(context);
ValuesSourceAggregatorFactory factory;
/*
The inner builder implementation is responsible for validating the
ValuesSourceType mapping, typically by checking if an aggregation
supplier has been registered for that type on this aggregation, and
throw IllegalArgumentException if the mapping is not valid. Note
that we need to throw from here because
AbstractAggregationBuilder#build, which called this, will attempt to
register the agg usage next, and if the usage is invalid that will fail
with a weird error.
*/
factory = innerBuild(context, config, parent, subFactoriesBuilder);
return factory;
}
protected abstract ValuesSourceRegistry.RegistryKey getRegistryKey();
/**
* Aggregations should use this method to define a {@link ValuesSourceType} of last resort. This will only be used when the resolver
* can't find a field and the user hasn't provided a value type hint.
*
* @return The CoreValuesSourceType we expect this script to yield.
*/
protected abstract ValuesSourceType defaultValueSourceType();
/**
* Aggregations should override this if they need non-standard logic for resolving where to get values from. For example, join
* aggregations (like Parent and Child) ask the user to specify one side of the join and then look up the other field to read values
* from.
*
* The default implementation just uses the field and/or script the user provided.
*
* @return A {@link ValuesSourceConfig} configured based on the parsed field and/or script.
*/
protected ValuesSourceConfig resolveConfig(AggregationContext context) {
return ValuesSourceConfig.resolve(
context,
this.userValueTypeHint,
field,
script,
missing,
timeZone,
format,
this.defaultValueSourceType()
);
}
protected abstract ValuesSourceAggregatorFactory innerBuild(
AggregationContext context,
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 (userValueTypeHint != null) {
builder.field("value_type", userValueTypeHint.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, timeZone, userValueTypeHint);
}
@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(field, other.field)
&& Objects.equals(format, other.format)
&& Objects.equals(missing, other.missing)
&& Objects.equals(script, other.script)
&& Objects.equals(timeZone, other.timeZone)
&& Objects.equals(userValueTypeHint, other.userValueTypeHint);
}
}