Add parsing method for binary range aggregation #24706
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| /* | ||
| * 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.bucket.range; | ||
|
|
||
| import org.elasticsearch.common.xcontent.ObjectParser; | ||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
| import org.elasticsearch.common.xcontent.XContentParser; | ||
| import org.elasticsearch.common.xcontent.XContentParserUtils; | ||
| import org.elasticsearch.search.aggregations.Aggregation; | ||
| import org.elasticsearch.search.aggregations.Aggregations; | ||
| import org.elasticsearch.search.aggregations.ParsedMultiBucketAggregation; | ||
| import org.elasticsearch.search.aggregations.bucket.range.ip.IpRangeAggregationBuilder; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import static org.elasticsearch.common.xcontent.XContentParserUtils.ensureExpectedToken; | ||
|
|
||
| public class ParsedBinaryRange extends ParsedMultiBucketAggregation<ParsedBinaryRange.ParsedBucket> implements Range { | ||
|
|
||
| @Override | ||
| public String getType() { | ||
| return IpRangeAggregationBuilder.NAME; | ||
| } | ||
|
|
||
| @Override | ||
| public List<? extends Range.Bucket> getBuckets() { | ||
| return buckets; | ||
| } | ||
|
|
||
| private static ObjectParser<ParsedBinaryRange, Void> PARSER = | ||
| new ObjectParser<>(ParsedBinaryRange.class.getSimpleName(), true, ParsedBinaryRange::new); | ||
| static { | ||
| declareMultiBucketAggregationFields(PARSER, | ||
| parser -> ParsedBucket.fromXContent(parser, false), | ||
| parser -> ParsedBucket.fromXContent(parser, true)); | ||
| } | ||
|
|
||
| public static ParsedBinaryRange fromXContent(XContentParser parser, String name) throws IOException { | ||
| ParsedBinaryRange aggregation = PARSER.parse(parser, null); | ||
| aggregation.setName(name); | ||
| return aggregation; | ||
| } | ||
|
|
||
| public static class ParsedBucket extends ParsedMultiBucketAggregation.ParsedBucket implements Range.Bucket { | ||
|
|
||
| private String key; | ||
| private String from; | ||
| private String to; | ||
|
|
||
| @Override | ||
| public Object getKey() { | ||
| return key; | ||
| } | ||
|
|
||
| @Override | ||
| public String getKeyAsString() { | ||
| return key; | ||
| } | ||
|
|
||
| @Override | ||
| public Object getFrom() { | ||
| return from; | ||
| } | ||
|
|
||
| @Override | ||
| public String getFromAsString() { | ||
| return from; | ||
| } | ||
|
|
||
| @Override | ||
| public Object getTo() { | ||
| return to; | ||
| } | ||
|
|
||
| @Override | ||
| public String getToAsString() { | ||
| return to; | ||
| } | ||
|
|
||
| @Override | ||
| public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { | ||
| if (isKeyed()) { | ||
| builder.startObject(key != null ? key : rangeKey(from, to)); | ||
| } else { | ||
| builder.startObject(); | ||
| if (key != null) { | ||
| builder.field(CommonFields.KEY.getPreferredName(), key); | ||
| } | ||
| } | ||
| if (from != null) { | ||
| builder.field(CommonFields.FROM.getPreferredName(), getFrom()); | ||
| } | ||
| if (to != null) { | ||
| builder.field(CommonFields.TO.getPreferredName(), getTo()); | ||
| } | ||
| builder.field(CommonFields.DOC_COUNT.getPreferredName(), getDocCount()); | ||
| getAggregations().toXContentInternal(builder, params); | ||
| builder.endObject(); | ||
| return builder; | ||
| } | ||
|
|
||
| static ParsedBucket fromXContent(final XContentParser parser, final boolean keyed) throws IOException { | ||
| final ParsedBucket bucket = new ParsedBucket(); | ||
| bucket.setKeyed(keyed); | ||
| XContentParser.Token token = parser.currentToken(); | ||
| String currentFieldName = parser.currentName(); | ||
|
|
||
| String rangeKey = null; | ||
| if (keyed) { | ||
| ensureExpectedToken(XContentParser.Token.FIELD_NAME, token, parser::getTokenLocation); | ||
| rangeKey = currentFieldName; | ||
| ensureExpectedToken(XContentParser.Token.START_OBJECT, parser.nextToken(), parser::getTokenLocation); | ||
| } | ||
|
|
||
| List<Aggregation> 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.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.text(); | ||
| } else if (CommonFields.TO.getPreferredName().equals(currentFieldName)) { | ||
| bucket.to = parser.text(); | ||
| } | ||
| } else if (token == XContentParser.Token.START_OBJECT) { | ||
| aggregations.add(XContentParserUtils.parseTypedKeysObject(parser, Aggregation.TYPED_KEYS_DELIMITER, Aggregation.class)); | ||
| } | ||
| } | ||
| bucket.setAggregations(new Aggregations(aggregations)); | ||
|
|
||
| if (keyed) { | ||
| if (rangeKey(bucket.from, bucket.to).equals(rangeKey)) { | ||
| bucket.key = null; | ||
|
||
| } else { | ||
| bucket.key = rangeKey; | ||
| } | ||
| } | ||
| return bucket; | ||
| } | ||
|
|
||
| private static String rangeKey(String from, String to) { | ||
| return (from == null ? "*" : from) + '-' + (to == null ? "*" : to); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it is ok to return null here when calling getKey and getKeyAsString? Although with keyed response we actually do print out a key? Seems like this behaviour doesn't align to REST but does align with what transport client does today?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I might be missing something but my latest changes should align the behavior... When the key is null, a keyed response will generate a string to name the object in the XContent response but the getKey/getKeyAsString will still return null.
This is what we do here: when we stop to parse the response, we check if the response was keyed and in this case we "try to detect" if the key has been generated on purpose using the from/to values. If so, we know that the original key is null et we set it explicitly.
The InternalMultiBucketAggregationTestCase.assertBucket() takes care of verifying that the getKey/getKeyAsString methods returns the same values after the parsing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I had missed that last line :) sorry!