generated from amazon-archives/__template_Custom
-
Notifications
You must be signed in to change notification settings - Fork 178
Scaffolding: top/rare useOther and percentage arguments #4335
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Swiddis
wants to merge
12
commits into
opensearch-project:main
Choose a base branch
from
Swiddis:feature/top-enhancements
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 8 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
662c75c
Add support for parsing new rare/top args
Swiddis 77612d7
Merge remote-tracking branch 'upstream/main' into feature/top-enhance…
Swiddis 7daab97
Add new top/rare fields to the anonymizer
Swiddis e04e792
Handle new args
Swiddis 61b6c69
Create dedicated data class for top/rare args
Swiddis f7754ae
Allow arbitrary rare/top argument ordering
Swiddis 628e2dc
Remove todo
Swiddis 5f0effe
Add validation for top/rare result count
Swiddis 4a21ffc
Tweak wording
Swiddis 0c11423
Merge branch 'main' into feature/top-enhancements
Swiddis 6bd130b
Apply spotless
Swiddis 049e548
Merge branch 'main' into feature/top-enhancements
Swiddis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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
117 changes: 117 additions & 0 deletions
117
core/src/main/java/org/opensearch/sql/ast/tree/args/RareTopNArguments.java
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,117 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.sql.ast.tree.args; | ||
|
|
||
| import static org.opensearch.sql.ast.dsl.AstDSL.argument; | ||
| import static org.opensearch.sql.ast.dsl.AstDSL.booleanLiteral; | ||
| import static org.opensearch.sql.ast.dsl.AstDSL.exprList; | ||
| import static org.opensearch.sql.ast.dsl.AstDSL.intLiteral; | ||
| import static org.opensearch.sql.ast.dsl.AstDSL.stringLiteral; | ||
|
|
||
| import java.util.List; | ||
| import lombok.AllArgsConstructor; | ||
| import lombok.EqualsAndHashCode; | ||
| import lombok.Getter; | ||
| import lombok.NoArgsConstructor; | ||
| import lombok.ToString; | ||
| import org.jetbrains.annotations.TestOnly; | ||
| import org.opensearch.sql.ast.expression.Argument; | ||
|
|
||
| @ToString | ||
| @EqualsAndHashCode | ||
| @Getter | ||
| @NoArgsConstructor | ||
| @AllArgsConstructor | ||
| public class RareTopNArguments { | ||
| public static final String NUMBER_RESULTS = "noOfResults"; | ||
| public static final String COUNT_FIELD = "countField"; | ||
| public static final String SHOW_COUNT = "showCount"; | ||
| public static final String PERCENT_FIELD = "percentField"; | ||
| public static final String SHOW_PERCENT = "showPerc"; | ||
| public static final String USE_OTHER = "useOther"; | ||
|
|
||
| private int noOfResults = 10; | ||
| private String countField = "count"; | ||
| private boolean showCount = true; | ||
| private String percentField = "percent"; | ||
| private boolean showPerc = false; | ||
| private boolean useOther = false; | ||
|
|
||
| public RareTopNArguments(List<Argument> arguments) { | ||
Swiddis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // handle `percent=whatever showperc=false` (though I'm not sure if it's ever useful to do so) | ||
| boolean isShowPercOverridden = false; | ||
|
|
||
| for (Argument arg : arguments) { | ||
| switch (arg.getArgName()) { | ||
| case NUMBER_RESULTS: | ||
| noOfResults = (int) arg.getValue().getValue(); | ||
| if (noOfResults < 1) { | ||
| throw new IllegalArgumentException( | ||
| "Illegal number of results requested for top/rare: must return at least one" | ||
| + " result"); | ||
| } | ||
| break; | ||
| case COUNT_FIELD: | ||
| countField = (String) arg.getValue().getValue(); | ||
| if (countField.isBlank()) { | ||
| throw new IllegalArgumentException("Illegal count field in top/rare: cannot be blank"); | ||
| } | ||
| break; | ||
| case SHOW_COUNT: | ||
| showCount = (boolean) arg.getValue().getValue(); | ||
| break; | ||
| case PERCENT_FIELD: | ||
| percentField = (String) arg.getValue().getValue(); | ||
| if (percentField.isBlank()) { | ||
| throw new IllegalArgumentException( | ||
| "Illegal percent field in top/rare: cannot be blank"); | ||
| } | ||
| if (!isShowPercOverridden) { | ||
| showPerc = true; | ||
| } | ||
| break; | ||
| case SHOW_PERCENT: | ||
| showPerc = (boolean) arg.getValue().getValue(); | ||
| isShowPercOverridden = true; | ||
| break; | ||
| case USE_OTHER: | ||
| useOther = (boolean) arg.getValue().getValue(); | ||
| break; | ||
| default: | ||
| throw new IllegalArgumentException("unknown argument for rare/top: " + arg.getArgName()); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public String renderOptions() { | ||
| StringBuilder options = new StringBuilder(); | ||
| if (showCount) { | ||
| options.append("countfield='").append(countField).append("' "); | ||
| } else { | ||
| options.append("showcount=false "); | ||
| } | ||
| if (showPerc) { | ||
| options.append("percfield='").append(percentField).append("' "); | ||
| } else { | ||
| options.append("showperc=false "); | ||
| } | ||
| if (useOther) { | ||
| options.append("useother=true "); | ||
| } | ||
| return options.toString(); | ||
| } | ||
|
|
||
| @TestOnly | ||
| public List<Argument> asExprList() { | ||
| return exprList( | ||
| argument("noOfResults", intLiteral(10)), | ||
| argument("countField", stringLiteral("count")), | ||
| argument("showCount", booleanLiteral(true)), | ||
| argument("percentField", stringLiteral("percent")), | ||
| argument("showPerc", booleanLiteral(false)), | ||
| argument("useOther", booleanLiteral(false))); | ||
| } | ||
| } | ||
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.
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.
small build change, makes precommit faster (check always runs after apply)