org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder 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
/*
* 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.pipeline;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.search.aggregations.PipelineAggregationBuilder;
import org.elasticsearch.xcontent.ParseField;
import org.elasticsearch.xcontent.XContentBuilder;
import java.io.IOException;
import java.util.Arrays;
import java.util.Map;
import java.util.Objects;
/**
* Base implementation of a {@link PipelineAggregationBuilder}.
*/
public abstract class AbstractPipelineAggregationBuilder> extends
PipelineAggregationBuilder {
/**
* Field shared by many parsers.
*/
public static final ParseField BUCKETS_PATH_FIELD = new ParseField("buckets_path");
protected final String type;
protected Map metadata;
protected AbstractPipelineAggregationBuilder(String name, String type, String[] bucketsPaths) {
super(name, bucketsPaths);
if (type == null) {
throw new IllegalArgumentException("[type] must not be null: [" + name + "]");
}
this.type = type;
}
/**
* Read from a stream.
*/
protected AbstractPipelineAggregationBuilder(StreamInput in, String type) throws IOException {
this(in.readString(), type, in.readStringArray());
metadata = in.readMap();
}
@Override
public void writeTo(StreamOutput out) throws IOException {
out.writeString(name);
out.writeStringArray(bucketsPaths);
out.writeMap(metadata);
doWriteTo(out);
}
protected abstract void doWriteTo(StreamOutput out) throws IOException;
public String type() {
return type;
}
protected abstract PipelineAggregator createInternal(Map metadata);
/**
* Creates the pipeline aggregator
*
* @return The created aggregator
*/
@Override
public final PipelineAggregator create() {
PipelineAggregator aggregator = createInternal(this.metadata);
return aggregator;
}
@SuppressWarnings("unchecked")
@Override
public PAB setMetadata(Map metadata) {
this.metadata = metadata;
return (PAB) this;
}
@Override
public final XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
builder.startObject(getName());
if (this.metadata != null) {
builder.field("meta", this.metadata);
}
builder.startObject(type);
if (overrideBucketsPath() == false && bucketsPaths != null) {
builder.startArray(PipelineAggregator.Parser.BUCKETS_PATH.getPreferredName());
for (String path : bucketsPaths) {
builder.value(path);
}
builder.endArray();
}
internalXContent(builder, params);
builder.endObject();
return builder.endObject();
}
/**
* @return true
if the {@link AbstractPipelineAggregationBuilder}
* overrides the XContent rendering of the bucketPath option.
*/
protected boolean overrideBucketsPath() {
return false;
}
protected abstract XContentBuilder internalXContent(XContentBuilder builder, Params params) throws IOException;
@Override
public int hashCode() {
return Objects.hash(Arrays.hashCode(bucketsPaths), metadata, name, type);
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null || getClass() != obj.getClass()) return false;
@SuppressWarnings("unchecked")
AbstractPipelineAggregationBuilder other = (AbstractPipelineAggregationBuilder) obj;
return Objects.equals(type, other.type)
&& Objects.equals(name, other.name)
&& Objects.equals(metadata, other.metadata)
&& Objects.deepEquals(bucketsPaths, other.bucketsPaths);
}
@Override
public String getType() {
return type;
}
}