Create a Field Replacement Visitor for replacing fields in ranges #3211
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,48 @@ | ||
| package datawave.query.planner.replacement; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| import org.apache.commons.jexl3.parser.ASTAndNode; | ||
| import org.apache.commons.jexl3.parser.ASTIdentifier; | ||
| import org.apache.commons.jexl3.parser.ASTJexlScript; | ||
| import org.apache.commons.jexl3.parser.JexlNode; | ||
| import org.apache.log4j.Logger; | ||
|
|
||
| import datawave.core.common.logging.ThreadConfigurableLogger; | ||
| import datawave.query.jexl.visitors.RebuildingVisitor; | ||
| import datawave.query.planner.replacement.rules.FieldReplacementRule; | ||
|
|
||
| public class FieldReplacementVisitor extends RebuildingVisitor { | ||
|
|
||
| private static final Logger log = ThreadConfigurableLogger.getLogger(FieldReplacementVisitor.class); | ||
| private final List<FieldReplacementRule> rules; | ||
|
|
||
| public FieldReplacementVisitor(List<FieldReplacementRule> rules) { | ||
| this.rules = rules; | ||
| } | ||
|
|
||
| public static ASTJexlScript apply(ASTJexlScript script, List<FieldReplacementRule> rules) { | ||
| FieldReplacementVisitor visitor = new FieldReplacementVisitor(rules); | ||
|
|
||
| return visitor.apply(script); | ||
| } | ||
|
|
||
| @Override | ||
| public Object visit(ASTAndNode node, Object data) { | ||
| return applyRules(super.visit(node, data)); | ||
| } | ||
|
|
||
| @Override | ||
| public Object visit(ASTIdentifier node, Object data) { | ||
| return applyRules(super.visit(node, data)); | ||
| } | ||
|
Comment on lines
+35
to
+37
Collaborator
There was a problem hiding this comment. We typically avoid overriding the visit method to an identifier node. Instead you may want to override the specific nodes you care about, EQ, NE, ER, RN, LT, LE, GT, GE, etc. |
||
|
|
||
| public JexlNode applyRules(Object node) { | ||
| JexlNode jexlNode = (JexlNode) node; | ||
| for (FieldReplacementRule rule : rules) { | ||
| if (rule.matches(jexlNode)) { | ||
| jexlNode = rule.apply(jexlNode); | ||
| } | ||
| } | ||
| return jexlNode; | ||
| } | ||
| } | ||
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,43 @@ | ||
| package datawave.query.planner.replacement.rules; | ||
|
|
||
| import org.apache.commons.jexl3.parser.ASTIdentifier; | ||
| import org.apache.commons.jexl3.parser.JexlNode; | ||
|
|
||
| import datawave.query.jexl.JexlASTHelper; | ||
|
|
||
| public class DirectFieldReplacementRule implements FieldReplacementRule { | ||
|
Collaborator
There was a problem hiding this comment. Add class level documentation for what the expected behavior is, what types of nodes are affected, etc |
||
| private String field = null; | ||
| private String replacement = null; | ||
|
Comment on lines
+9
to
+10
|
||
|
|
||
| public DirectFieldReplacementRule() {} | ||
|
|
||
| public DirectFieldReplacementRule(String field, String replacement) { | ||
| this.field = field; | ||
| this.replacement = replacement; | ||
| } | ||
|
|
||
| public boolean matches(JexlNode node) { | ||
| return node instanceof ASTIdentifier && ((ASTIdentifier) node).getName().equals(field); | ||
| } | ||
|
|
||
| public JexlNode apply(JexlNode node) { | ||
| JexlASTHelper.setField(node, replacement); | ||
| return node; | ||
| } | ||
|
|
||
| public String getField() { | ||
| return field; | ||
| } | ||
|
|
||
| public void setField(String field) { | ||
| this.field = field; | ||
| } | ||
|
|
||
| public String getReplacement() { | ||
| return replacement; | ||
| } | ||
|
|
||
| public void setReplacement(String replacement) { | ||
| this.replacement = replacement; | ||
| } | ||
| } | ||
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,9 @@ | ||
| package datawave.query.planner.replacement.rules; | ||
|
|
||
| import org.apache.commons.jexl3.parser.JexlNode; | ||
|
|
||
| public interface FieldReplacementRule { | ||
|
Collaborator
There was a problem hiding this comment. Add brief class level doc |
||
| boolean matches(JexlNode node); | ||
|
|
||
| JexlNode apply(JexlNode node); | ||
| } | ||
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,85 @@ | ||
| package datawave.query.planner.replacement.rules; | ||
|
|
||
| import static datawave.query.jexl.nodes.QueryPropertyMarker.MarkerType.EVALUATION_ONLY; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| import org.apache.commons.jexl3.parser.ASTAndNode; | ||
| import org.apache.commons.jexl3.parser.ASTIdentifier; | ||
| import org.apache.commons.jexl3.parser.ASTReferenceExpression; | ||
| import org.apache.commons.jexl3.parser.JexlNode; | ||
| import org.apache.commons.jexl3.parser.JexlNodes; | ||
| import org.apache.commons.jexl3.parser.ParserTreeConstants; | ||
|
|
||
| import datawave.query.jexl.JexlASTHelper; | ||
| import datawave.query.jexl.JexlNodeFactory; | ||
| import datawave.query.jexl.LiteralRange; | ||
| import datawave.query.jexl.nodes.QueryPropertyMarker; | ||
| import datawave.query.jexl.visitors.RebuildingVisitor; | ||
|
|
||
| public class RangeFieldReplacementRule implements FieldReplacementRule { | ||
|
Collaborator
There was a problem hiding this comment. Visitor name should be updated to include "BoundedRange", range on it's own could be any range operator (LT, LE, GT, GE). The direct field replacement rule actually replaces the field. This visitor doesn't actually replace the bounded range, consider an alternate name. |
||
| private Map<String,String> fieldMap = new HashMap<>(); | ||
|
|
||
| public RangeFieldReplacementRule() {} | ||
|
|
||
| public RangeFieldReplacementRule(Map<String,String> fieldMap) { | ||
| this.fieldMap = fieldMap; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean matches(JexlNode node) { | ||
| LiteralRange<?> range = JexlASTHelper.findRange().getRange(node); | ||
| return range != null && fieldMap.containsKey(range.getFieldName()); | ||
| } | ||
|
|
||
| @Override | ||
| public JexlNode apply(JexlNode node) { | ||
| LiteralRange<?> range = JexlASTHelper.findRange().getRange(node); | ||
|
|
||
| if (range == null || !fieldMap.containsKey(range.getFieldName())) { | ||
| return node; | ||
| } | ||
|
|
||
| // Create a copy and mark it as "evaluationOnly" | ||
| JexlNode copy = RebuildingVisitor.copy(node); | ||
| JexlNode evalNode = QueryPropertyMarker.create(copy, EVALUATION_ONLY); | ||
|
Collaborator
There was a problem hiding this comment. Why mark the original as evaluation only? Are the replacement fields always indexed? If you had a case where the original field is indexed and the replacement field is not indexed then the executability of the query was just destroyed, in cases where the bounded range is an anchor term. |
||
|
|
||
| // rename the field for the range nodes | ||
| replaceField(range.getLowerNode(), fieldMap.get(range.getFieldName())); | ||
| replaceField(range.getUpperNode(), fieldMap.get(range.getFieldName())); | ||
|
|
||
| // Create a Reference Expression for the original node and top level AND for both the ref and the eval node | ||
| ASTReferenceExpression ref = JexlNodes.makeRefExp(); | ||
| ASTAndNode topLevel = new ASTAndNode(ParserTreeConstants.JJTANDNODE); | ||
| node.jjtSetParent(ref); | ||
| ref.jjtSetParent(topLevel); | ||
| evalNode.jjtSetParent(topLevel); | ||
| ref.jjtAddChild(node, 0); | ||
| topLevel.jjtAddChild(evalNode, 0); | ||
| topLevel.jjtAddChild(ref, 1); | ||
|
|
||
| return topLevel; | ||
| } | ||
|
|
||
| private void replaceField(JexlNode node, String newName) { | ||
| for (int i = 0; i < node.jjtGetNumChildren(); i++) { | ||
| JexlNode child = node.jjtGetChild(i); | ||
| if (child instanceof ASTIdentifier) { | ||
| ASTIdentifier newId = JexlNodeFactory.buildIdentifier(newName); | ||
| node.jjtAddChild(newId, i); | ||
| newId.jjtSetParent(node); | ||
| } else { | ||
| replaceField(child, newName); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public void setFieldMap(Map<String,String> fieldMap) { | ||
| this.fieldMap = fieldMap; | ||
| } | ||
|
|
||
| public Map<String,String> getFieldMap() { | ||
| return fieldMap; | ||
| } | ||
| } | ||
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.
double negatives have gotten us into trouble in the past. This should be one of the following