org.opensearch.search.aggregations.bucket.range.ParsedRange 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.common.CheckedFunction;
import org.opensearch.core.xcontent.ObjectParser;
import org.opensearch.core.xcontent.XContentBuilder;
import org.opensearch.core.xcontent.XContentParser;
import org.opensearch.core.xcontent.XContentParserUtils;
import org.opensearch.search.aggregations.Aggregation;
import org.opensearch.search.aggregations.Aggregations;
import org.opensearch.search.aggregations.ParsedMultiBucketAggregation;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.function.Supplier;
import static org.opensearch.core.xcontent.XContentParserUtils.ensureExpectedToken;
/**
* A range agg result parsed between nodes
*
* @opensearch.internal
*/
public class ParsedRange extends ParsedMultiBucketAggregation implements Range {
@Override
public String getType() {
return RangeAggregationBuilder.NAME;
}
@Override
public List getBuckets() {
return buckets;
}
protected static void declareParsedRangeFields(
final ObjectParser objectParser,
final CheckedFunction bucketParser,
final CheckedFunction keyedBucketParser
) {
declareMultiBucketAggregationFields(objectParser, bucketParser::apply, keyedBucketParser::apply);
}
private static final ObjectParser PARSER = new ObjectParser<>(
ParsedRange.class.getSimpleName(),
true,
ParsedRange::new
);
static {
declareParsedRangeFields(
PARSER,
parser -> ParsedBucket.fromXContent(parser, false),
parser -> ParsedBucket.fromXContent(parser, true)
);
}
public static ParsedRange fromXContent(XContentParser parser, String name) throws IOException {
ParsedRange aggregation = PARSER.parse(parser, null);
aggregation.setName(name);
return aggregation;
}
/**
* Parsed bucket for a range
*
* @opensearch.internal
*/
public static class ParsedBucket extends ParsedMultiBucketAggregation.ParsedBucket implements Range.Bucket {
protected String key;
protected double from = Double.NEGATIVE_INFINITY;
protected String fromAsString;
protected double to = Double.POSITIVE_INFINITY;
protected String toAsString;
@Override
public String getKey() {
return getKeyAsString();
}
@Override
public String getKeyAsString() {
String keyAsString = super.getKeyAsString();
if (keyAsString != null) {
return keyAsString;
}
return key;
}
@Override
public Object getFrom() {
return from;
}
@Override
public String getFromAsString() {
if (fromAsString != null) {
return fromAsString;
}
return doubleAsString(from);
}
@Override
public Object getTo() {
return to;
}
@Override
public String getToAsString() {
if (toAsString != null) {
return toAsString;
}
return doubleAsString(to);
}
@Override
public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
if (isKeyed()) {
builder.startObject(key);
} else {
builder.startObject();
builder.field(CommonFields.KEY.getPreferredName(), key);
}
if (Double.isInfinite(from) == false) {
builder.field(CommonFields.FROM.getPreferredName(), from);
if (fromAsString != null) {
builder.field(CommonFields.FROM_AS_STRING.getPreferredName(), fromAsString);
}
}
if (Double.isInfinite(to) == false) {
builder.field(CommonFields.TO.getPreferredName(), to);
if (toAsString != null) {
builder.field(CommonFields.TO_AS_STRING.getPreferredName(), toAsString);
}
}
builder.field(CommonFields.DOC_COUNT.getPreferredName(), getDocCount());
getAggregations().toXContentInternal(builder, params);
builder.endObject();
return builder;
}
private static String doubleAsString(double d) {
return Double.isInfinite(d) ? null : Double.toString(d);
}
protected static B parseRangeBucketXContent(
final XContentParser parser,
final Supplier bucketSupplier,
final boolean keyed
) throws IOException {
final B bucket = bucketSupplier.get();
bucket.setKeyed(keyed);
XContentParser.Token token = parser.currentToken();
String currentFieldName = parser.currentName();
if (keyed) {
ensureExpectedToken(XContentParser.Token.FIELD_NAME, token, parser);
bucket.key = currentFieldName;
ensureExpectedToken(XContentParser.Token.START_OBJECT, parser.nextToken(), parser);
}
List aggregations = new ArrayList<>();
while ((token = parser.nextToken()) != XContentParser.Token.END_OBJECT) {
if (token == XContentParser.Token.FIELD_NAME) {
currentFieldName = parser.currentName();
} else if (token.isValue()) {
if (CommonFields.KEY_AS_STRING.getPreferredName().equals(currentFieldName)) {
bucket.setKeyAsString(parser.text());
} else if (CommonFields.KEY.getPreferredName().equals(currentFieldName)) {
bucket.key = parser.text();
} else if (CommonFields.DOC_COUNT.getPreferredName().equals(currentFieldName)) {
bucket.setDocCount(parser.longValue());
} else if (CommonFields.FROM.getPreferredName().equals(currentFieldName)) {
bucket.from = parser.doubleValue();
} else if (CommonFields.FROM_AS_STRING.getPreferredName().equals(currentFieldName)) {
bucket.fromAsString = parser.text();
} else if (CommonFields.TO.getPreferredName().equals(currentFieldName)) {
bucket.to = parser.doubleValue();
} else if (CommonFields.TO_AS_STRING.getPreferredName().equals(currentFieldName)) {
bucket.toAsString = parser.text();
}
} else if (token == XContentParser.Token.START_OBJECT) {
XContentParserUtils.parseTypedKeysObject(
parser,
Aggregation.TYPED_KEYS_DELIMITER,
Aggregation.class,
aggregations::add
);
}
}
bucket.setAggregations(new Aggregations(aggregations));
return bucket;
}
static ParsedBucket fromXContent(final XContentParser parser, final boolean keyed) throws IOException {
return parseRangeBucketXContent(parser, ParsedBucket::new, keyed);
}
}
}