[GitHub] [accumulo-access] keith-turner commented on a diff in pull request #15: improves project documentation

["keith-turner (via GitHub)" <gi...@apache.org>]

keith-turner commented on code in PR #15:
URL: https://github.com/apache/accumulo-access/pull/15#discussion_r1337415876


##########
src/main/java/org/apache/accumulo/access/AccessExpression.java:
##########
@@ -63,7 +57,13 @@ public interface AccessExpression {
   String getExpression();
 
   /**
-   * TODO give examples
+   * Deduplicate, sort, and flatten expressions.
+   *
+   * <p>As an example of flattening, the expression {@code A&(B&C)} can be flattened to {@code A&B&C}.
+   *
+   * <p>As an example of sorting, the expression {@code (Z&Y)|(C&B)} can be sorted to {@code (B&C)|(Y&Z)}

Review Comment:
   > Do we want to cover the case where a user may not want to sort?
   
   Possibly, but I would wait and see what is requested.  If someone is crafting their expressions with such care they may have other surprising requirements that they would want from an expression transformation. For example instead of not sorting, maybe someone would want to pass a custom comparator.  Or maybe someone's transformation request is so complex that we just point them to the antlr example instead of trying to implement it in the base library.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org