org.opensearch.search.aggregations.bucket.range.InternalRange Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensearch Show documentation
Show all versions of opensearch Show documentation
OpenSearch subproject :server
/*
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*/
/*
* 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.
*/
/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/
package org.opensearch.search.aggregations.bucket.range;
import org.opensearch.core.common.io.stream.StreamInput;
import org.opensearch.core.common.io.stream.StreamOutput;
import org.opensearch.core.xcontent.XContentBuilder;
import org.opensearch.search.DocValueFormat;
import org.opensearch.search.aggregations.Aggregations;
import org.opensearch.search.aggregations.InternalAggregation;
import org.opensearch.search.aggregations.InternalAggregations;
import org.opensearch.search.aggregations.InternalMultiBucketAggregation;
import org.opensearch.search.aggregations.support.CoreValuesSourceType;
import org.opensearch.search.aggregations.support.ValueType;
import org.opensearch.search.aggregations.support.ValuesSourceType;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
/**
* Implementation of range bucket
*
* @opensearch.internal
*/
public class InternalRange> extends InternalMultiBucketAggregation
implements
Range {
static final Factory FACTORY = new Factory();
/**
* Bucket for a range
*
* @opensearch.internal
*/
public static class Bucket extends InternalMultiBucketAggregation.InternalBucket implements Range.Bucket {
protected final transient boolean keyed;
protected final transient DocValueFormat format;
protected final double from;
protected final double to;
private final long docCount;
private final InternalAggregations aggregations;
private final String key;
public Bucket(
String key,
double from,
double to,
long docCount,
InternalAggregations aggregations,
boolean keyed,
DocValueFormat format
) {
this.keyed = keyed;
this.format = format;
this.key = key != null ? key : generateKey(from, to, format);
this.from = from;
this.to = to;
this.docCount = docCount;
this.aggregations = aggregations;
}
@Override
public String getKey() {
return getKeyAsString();
}
@Override
public String getKeyAsString() {
return key;
}
@Override
public Object getFrom() {
return from;
}
@Override
public Object getTo() {
return to;
}
public boolean getKeyed() {
return keyed;
}
public DocValueFormat getFormat() {
return format;
}
@Override
public String getFromAsString() {
if (Double.isInfinite(from)) {
return null;
} else {
return format.format(from).toString();
}
}
@Override
public String getToAsString() {
if (Double.isInfinite(to)) {
return null;
} else {
return format.format(to).toString();
}
}
@Override
public long getDocCount() {
return docCount;
}
@Override
public Aggregations getAggregations() {
return aggregations;
}
protected Factory getFactory() {
return FACTORY;
}
@Override
public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
if (keyed) {
builder.startObject(key);
} else {
builder.startObject();
builder.field(CommonFields.KEY.getPreferredName(), key);
}
if (!Double.isInfinite(from)) {
builder.field(CommonFields.FROM.getPreferredName(), from);
if (format != DocValueFormat.RAW) {
builder.field(CommonFields.FROM_AS_STRING.getPreferredName(), format.format(from));
}
}
if (!Double.isInfinite(to)) {
builder.field(CommonFields.TO.getPreferredName(), to);
if (format != DocValueFormat.RAW) {
builder.field(CommonFields.TO_AS_STRING.getPreferredName(), format.format(to));
}
}
builder.field(CommonFields.DOC_COUNT.getPreferredName(), docCount);
aggregations.toXContentInternal(builder, params);
builder.endObject();
return builder;
}
private static String generateKey(double from, double to, DocValueFormat format) {
StringBuilder builder = new StringBuilder().append(Double.isInfinite(from) ? "*" : format.format(from))
.append("-")
.append(Double.isInfinite(to) ? "*" : format.format(to));
return builder.toString();
}
@Override
public void writeTo(StreamOutput out) throws IOException {
out.writeString(key);
out.writeDouble(from);
out.writeDouble(to);
out.writeVLong(docCount);
aggregations.writeTo(out);
}
@Override
public boolean equals(Object other) {
if (this == other) {
return true;
}
if (other == null || getClass() != other.getClass()) {
return false;
}
Bucket that = (Bucket) other;
return Objects.equals(from, that.from)
&& Objects.equals(to, that.to)
&& Objects.equals(docCount, that.docCount)
&& Objects.equals(aggregations, that.aggregations)
&& Objects.equals(key, that.key);
}
@Override
public int hashCode() {
return Objects.hash(getClass(), from, to, docCount, aggregations, key);
}
}
/**
* Factory for a range
*
* @opensearch.internal
*/
public static class Factory> {
public ValuesSourceType getValueSourceType() {
return CoreValuesSourceType.NUMERIC;
}
public ValueType getValueType() {
return ValueType.NUMERIC;
}
@SuppressWarnings("unchecked")
public R create(String name, List ranges, DocValueFormat format, boolean keyed, Map metadata) {
return (R) new InternalRange(name, ranges, format, keyed, metadata);
}
@SuppressWarnings("unchecked")
public B createBucket(
String key,
double from,
double to,
long docCount,
InternalAggregations aggregations,
boolean keyed,
DocValueFormat format
) {
return (B) new Bucket(key, from, to, docCount, aggregations, keyed, format);
}
@SuppressWarnings("unchecked")
public R create(List ranges, R prototype) {
return (R) new InternalRange(prototype.name, ranges, prototype.format, prototype.keyed, prototype.metadata);
}
@SuppressWarnings("unchecked")
public B createBucket(InternalAggregations aggregations, B prototype) {
return (B) new Bucket(
prototype.getKey(),
prototype.from,
prototype.to,
prototype.getDocCount(),
aggregations,
prototype.keyed,
prototype.format
);
}
}
private final List ranges;
protected final DocValueFormat format;
protected final boolean keyed;
public InternalRange(String name, List ranges, DocValueFormat format, boolean keyed, Map metadata) {
super(name, metadata);
this.ranges = ranges;
this.format = format;
this.keyed = keyed;
}
/**
* Read from a stream.
*/
public InternalRange(StreamInput in) throws IOException {
super(in);
format = in.readNamedWriteable(DocValueFormat.class);
keyed = in.readBoolean();
int size = in.readVInt();
List ranges = new ArrayList<>(size);
for (int i = 0; i < size; i++) {
String key = in.readString();
ranges.add(
getFactory().createBucket(
key,
in.readDouble(),
in.readDouble(),
in.readVLong(),
InternalAggregations.readFrom(in),
keyed,
format
)
);
}
this.ranges = ranges;
}
@Override
protected void doWriteTo(StreamOutput out) throws IOException {
out.writeNamedWriteable(format);
out.writeBoolean(keyed);
out.writeVInt(ranges.size());
for (B bucket : ranges) {
bucket.writeTo(out);
}
}
@Override
public String getWriteableName() {
return RangeAggregationBuilder.NAME;
}
@Override
public List getBuckets() {
return ranges;
}
public Factory getFactory() {
return FACTORY;
}
@SuppressWarnings("unchecked")
@Override
public R create(List buckets) {
return getFactory().create(buckets, (R) this);
}
@Override
public B createBucket(InternalAggregations aggregations, B prototype) {
return getFactory().createBucket(aggregations, prototype);
}
@SuppressWarnings("unchecked")
@Override
public InternalAggregation reduce(List aggregations, ReduceContext reduceContext) {
reduceContext.consumeBucketsAndMaybeBreak(ranges.size());
List[] rangeList = new List[ranges.size()];
for (int i = 0; i < rangeList.length; ++i) {
rangeList[i] = new ArrayList<>();
}
for (InternalAggregation aggregation : aggregations) {
InternalRange ranges = (InternalRange) aggregation;
int i = 0;
for (B range : ranges.ranges) {
rangeList[i++].add(range);
}
}
final List ranges = new ArrayList<>();
for (int i = 0; i < this.ranges.size(); ++i) {
ranges.add((B) reduceBucket(rangeList[i], reduceContext));
}
return getFactory().create(name, ranges, format, keyed, getMetadata());
}
@Override
protected B reduceBucket(List buckets, ReduceContext context) {
assert buckets.size() > 0;
long docCount = 0;
List aggregationsList = new ArrayList<>(buckets.size());
for (Bucket bucket : buckets) {
docCount += bucket.docCount;
aggregationsList.add(bucket.aggregations);
}
final InternalAggregations aggs = InternalAggregations.reduce(aggregationsList, context);
Bucket prototype = buckets.get(0);
return getFactory().createBucket(prototype.key, prototype.from, prototype.to, docCount, aggs, keyed, format);
}
@Override
public XContentBuilder doXContentBody(XContentBuilder builder, Params params) throws IOException {
if (keyed) {
builder.startObject(CommonFields.BUCKETS.getPreferredName());
} else {
builder.startArray(CommonFields.BUCKETS.getPreferredName());
}
for (B range : ranges) {
range.toXContent(builder, params);
}
if (keyed) {
builder.endObject();
} else {
builder.endArray();
}
return builder;
}
@Override
public int hashCode() {
return Objects.hash(super.hashCode(), ranges, format, keyed);
}
@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;
InternalRange that = (InternalRange) obj;
return Objects.equals(ranges, that.ranges) && Objects.equals(format, that.format) && Objects.equals(keyed, that.keyed);
}
}