#1322 modify the facetBy parameter type to make it work with namedGroup

Author: lling

marklogic-client-api/src/main/java/com/marklogic/client/expression/PlanBuilder.java

@@ -1410,26 +1410,6 @@ public interface ModifyPlan extends PreparePlan, PlanBuilderBase.ModifyPlanBase
   * @return  a ModifyPlan object
   */
   public abstract ModifyPlan existsJoin(ModifyPlan right, PlanJoinKeySeq keys, ServerExpression condition);
-/**
-  * This method counts values for multiple grouping key columns. 
-  * @param keys  This parameter specifies the list of column keys for performing counts. For each column, the operation determines the unique values of that column and produces a separate count for the rows with that value.  A column can be named with a string or a column parameter function such as op:col or constructed from an expression with the op:as function. See {@link PlanBuilder#colSeq(String...)}
-  * @return  a ModifyPlan object
-  */
-  public abstract ModifyPlan facetBy(PlanExprColSeq keys);
-/**
-  * This method counts values for multiple grouping key columns. 
-  * @param keys  This parameter specifies the list of column keys for performing counts. For each column, the operation determines the unique values of that column and produces a separate count for the rows with that value.  A column can be named with a string or a column parameter function such as op:col or constructed from an expression with the op:as function.  See {@link PlanBuilder#colSeq(String...)}
-  * @param countCol  Specifies what to count over the rows for each unique value of each key column.  By default, the operation counts the rows. To count the values of a column instead, specify the column to count with this parameter. To count documents, specify a fragment id column with op:fragment-id-col. 
-  * @return  a ModifyPlan object
-  */
-  public abstract ModifyPlan facetBy(PlanExprColSeq keys, String countCol);
-/**
-  * This method counts values for multiple grouping key columns. 
-  * @param keys  This parameter specifies the list of column keys for performing counts. For each column, the operation determines the unique values of that column and produces a separate count for the rows with that value.  A column can be named with a string or a column parameter function such as op:col or constructed from an expression with the op:as function.  See {@link PlanBuilder#colSeq(String...)}
-  * @param countCol  Specifies what to count over the rows for each unique value of each key column.  By default, the operation counts the rows. To count the values of a column instead, specify the column to count with this parameter. To count documents, specify a fragment id column with op:fragment-id-col. 
-  * @return  a ModifyPlan object
-  */
-  public abstract ModifyPlan facetBy(PlanExprColSeq keys, PlanExprCol countCol);
 /**
   * This method collapses a group of rows into a single row. 
   * @param keys  This parameter specifies the columns used to determine the groups. Rows with the same values in these columns are consolidated into a single group. The columns can be existing columns or new columns created by an expression specified with op:as. The rows produced by the group by operation include the key columns. Specify an empty sequence to create a single group for all of the rows in the row set. See {@link PlanBuilder#colSeq(String...)}

marklogic-client-api/src/main/java/com/marklogic/client/expression/PlanBuilderBase.java

@@ -664,6 +664,49 @@ interface ModifyPlanBase {
          * @return  a ModifyPlan object
          */
         PlanBuilder.ModifyPlan groupToArrays(PlanNamedGroupSeq keys, PlanAggregateColSeq aggregates);
+        /**
+         * This method counts values for multiple grouping key columns.
+         * @param keys  This parameter specifies the list of column keys or group keys for performing counts. For each
+         *              column/group, the operation determines the unique values of that column/group and produces a
+         *              separate count for the rows with that value.  A column can be named with a string or a column
+         *              parameter function such as op:col or constructed from an expression with the op:as function.
+         *              See {@link PlanBuilder#colSeq(String...)}.  A group can be a namedGroup or bucketGroup. see
+         *              {@link PlanBuilder#namedGroupSeq(PlanNamedGroup...)} , {@link PlanBuilder#namedGroup(String, PlanExprColSeq)}
+         *              and {@link PlanBuilder#bucketGroup(String, String, XsAnyAtomicTypeSeqVal)}
+         * @return  a ModifyPlan object
+         */
+        PlanBuilder.ModifyPlan facetBy(PlanNamedGroupSeq keys);
+        /**
+         * This method counts values for multiple grouping key columns.
+         * @param keys  This parameter specifies the list of column keys or group keys for performing counts. For each
+         *              column, the operation determines the unique values of that column/group and produces a separate
+         *              count for the rows with that value.  A column can be named with a string or a column parameter
+         *              function such as op:col or constructed from an expression with the op:as function.
+         *              See {@link PlanBuilder#colSeq(String...)}. A group can be a namedGroup or bucketGroup. see
+         *              {@link PlanBuilder#namedGroupSeq(PlanNamedGroup...)}, {@link PlanBuilder#namedGroup(String, PlanExprColSeq)}
+         *              and {@link PlanBuilder#bucketGroup(String, String, XsAnyAtomicTypeSeqVal)}.
+         * @param countCol  Specifies what to count over the rows for each unique value of each key column.  By default,
+         *                  the operation counts the rows. To count the values of a column instead, specify the column
+         *                  to count with this parameter. To count documents, specify a fragment id column with
+         *                  op:fragment-id-col.
+         * @return  a ModifyPlan object
+         */
+        PlanBuilder.ModifyPlan facetBy(PlanNamedGroupSeq keys, String countCol);
+        /**
+         * This method counts values for multiple grouping key columns.
+         * @param keys  This parameter specifies the list of column keys or group keys for performing counts. For each
+         *              column, the operation determines the unique values of that column/group and produces a separate
+         *              count for the rows with that value.  A column can be named with a string or a column parameter
+         *              function such as op:col or constructed from an expression with the op:as function.
+         *              See {@link PlanBuilder#colSeq(String...)}, {@link PlanBuilder#namedGroup(String, PlanExprColSeq)}
+         *              and {@link PlanBuilder#bucketGroup(String, String, XsAnyAtomicTypeSeqVal)}.
+         * @param countCol  Specifies what to count over the rows for each unique value of each key column.  By default,
+         *                  the operation counts the rows. To count the values of a column instead, specify the column
+         *                  to count with this parameter. To count documents, specify a fragment id column with
+         *                  op:fragment-id-col.
+         * @return  a ModifyPlan object
+         */
+        PlanBuilder.ModifyPlan facetBy(PlanNamedGroupSeq keys, PlanExprCol countCol);
 
         /**
          * This method returns a subset of the rows in the result set by returning the specified number of rows.

marklogic-client-api/src/main/java/com/marklogic/client/impl/PlanBuilderImpl.java

@@ -1652,31 +1652,7 @@ public ModifyPlan existsJoin(ModifyPlan right, PlanJoinKeySeq keys, ServerExpres
     return new PlanBuilderSubImpl.ModifyPlanSubImpl(this, "op", "exists-join", new Object[]{ right, keys, condition });
   }
 
-    
-  @Override
-  public ModifyPlan facetBy(PlanExprColSeq keys) {
-    if (keys == null) {
-      throw new IllegalArgumentException("keys parameter for facetBy() cannot be null");
-    }
-    return new PlanBuilderSubImpl.ModifyPlanSubImpl(this, "op", "facet-by", new Object[]{ keys });
-  }
-
-    
-  @Override
-  public ModifyPlan facetBy(PlanExprColSeq keys, String countCol) {
-    return facetBy(keys, (countCol == null) ? (PlanExprCol) null : exprCol(countCol));
-  }
-
-    
-  @Override
-  public ModifyPlan facetBy(PlanExprColSeq keys, PlanExprCol countCol) {
-    if (keys == null) {
-      throw new IllegalArgumentException("keys parameter for facetBy() cannot be null");
-    }
-    return new PlanBuilderSubImpl.ModifyPlanSubImpl(this, "op", "facet-by", new Object[]{ keys, countCol });
-  }
 
-    
   @Override
   public ModifyPlan groupBy(PlanExprColSeq keys) {
     return new PlanBuilderSubImpl.ModifyPlanSubImpl(this, "op", "group-by", new Object[]{ keys });

marklogic-client-api/src/main/java/com/marklogic/client/impl/PlanBuilderSubImpl.java

@@ -798,6 +798,25 @@ public PlanBuilder.ModifyPlan groupToArrays(PlanNamedGroupSeq keys, PlanAggregat
       return new PlanBuilderSubImpl.ModifyPlanSubImpl(this, "op", "group-to-arrays", new Object[]{ keys, aggregates });
     }
 
+    @Override
+    public ModifyPlan facetBy(PlanNamedGroupSeq keys) {
+      if (keys == null) {
+        throw new IllegalArgumentException("keys parameter for facetBy() cannot be null");
+      }
+      return new PlanBuilderSubImpl.ModifyPlanSubImpl(this, "op", "facet-by", new Object[]{ keys });
+    }
+    @Override
+    public ModifyPlan facetBy(PlanNamedGroupSeq keys, String countCol) {
+      return facetBy(keys, (countCol == null) ? (PlanExprCol) null : exprCol(countCol));
+    }
+    @Override
+    public ModifyPlan facetBy(PlanNamedGroupSeq keys, PlanExprCol countCol) {
+      if (keys == null) {
+        throw new IllegalArgumentException("keys parameter for facetBy() cannot be null");
+      }
+      return new PlanBuilderSubImpl.ModifyPlanSubImpl(this, "op", "facet-by", new Object[]{ keys, countCol });
+    }
+
     @Override
     public ModifyPlan limit(long length) {
       return limit(xs.longVal(length));