PercentageScore heuristic for significant_terms
#9747
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,101 @@ | ||
| /* | ||
| * 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.significant.heuristics; | ||
|
|
||
|
|
||
| import org.elasticsearch.ElasticsearchParseException; | ||
| import org.elasticsearch.common.io.stream.StreamInput; | ||
| import org.elasticsearch.common.io.stream.StreamOutput; | ||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
| import org.elasticsearch.common.xcontent.XContentParser; | ||
| import org.elasticsearch.index.query.QueryParsingException; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| public class PercentageScore extends SignificanceHeuristic { | ||
|
|
||
| public static final PercentageScore INSTANCE = new PercentageScore(); | ||
|
|
||
| protected static final String[] NAMES = {"percentage"}; | ||
|
|
||
| private PercentageScore() {}; | ||
|
|
||
| public static final SignificanceHeuristicStreams.Stream STREAM = new SignificanceHeuristicStreams.Stream() { | ||
| @Override | ||
| public SignificanceHeuristic readResult(StreamInput in) throws IOException { | ||
| return readFrom(in); | ||
| } | ||
|
|
||
| @Override | ||
| public String getName() { | ||
| return NAMES[0]; | ||
| } | ||
| }; | ||
|
|
||
| public static SignificanceHeuristic readFrom(StreamInput in) throws IOException { | ||
| return INSTANCE; | ||
| } | ||
|
|
||
| /** | ||
| * Indicates the significance of a term in a sample by determining what percentage | ||
| * of all occurrences of a term are found in the sample. | ||
| */ | ||
| @Override | ||
| public double getScore(long subsetFreq, long subsetSize, long supersetFreq, long supersetSize) { | ||
| checkFrequencyValidity(subsetFreq, subsetSize, supersetFreq, supersetSize, "PercentageScore"); | ||
| if (supersetFreq == 0) { | ||
|
||
| // avoid a divide by zero issue | ||
| return 0; | ||
| } | ||
| return (double) subsetFreq / (double) supersetFreq; | ||
| } | ||
|
|
||
| @Override | ||
| public void writeTo(StreamOutput out) throws IOException { | ||
| out.writeString(STREAM.getName()); | ||
| } | ||
|
|
||
| public static class PercentageScoreParser implements SignificanceHeuristicParser { | ||
|
|
||
| @Override | ||
| public SignificanceHeuristic parse(XContentParser parser) throws IOException, QueryParsingException { | ||
| // move to the closing bracket | ||
| if (!parser.nextToken().equals(XContentParser.Token.END_OBJECT)) { | ||
| throw new ElasticsearchParseException("expected }, got " + parser.currentName() + " instead in percentage score"); | ||
| } | ||
| return new PercentageScore(); | ||
| } | ||
|
|
||
| @Override | ||
| public String[] getNames() { | ||
| return NAMES; | ||
| } | ||
| } | ||
|
|
||
| public static class PercentageScoreBuilder implements SignificanceHeuristicBuilder { | ||
|
|
||
| @Override | ||
| public void toXContent(XContentBuilder builder) throws IOException { | ||
| builder.startObject(STREAM.getName()).endObject(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
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
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.
Does this need to be a String[]? We seem to only use it in one place where we just get the first element anyway so would it not be better as a plain String?
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.
The SignificanceHeuristicParser base class has a getNames() method that requires an array of names (presumably to allow for alternatives) so this is returned there
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.
Ah ok, I missing that method below, sorry.