More expression work

Author: tom-andersen

firebase-firestore/api.txt

@@ -691,35 +691,35 @@ package com.google.firebase.firestore.pipeline {
 
   public final class AggregateFunction {
     method public com.google.firebase.firestore.pipeline.AggregateWithAlias alias(String alias);
-    method public static com.google.firebase.firestore.pipeline.AggregateFunction avg(com.google.firebase.firestore.pipeline.Expr expr);
+    method public static com.google.firebase.firestore.pipeline.AggregateFunction avg(com.google.firebase.firestore.pipeline.Expr expression);
     method public static com.google.firebase.firestore.pipeline.AggregateFunction avg(String fieldName);
-    method public static com.google.firebase.firestore.pipeline.AggregateFunction count(com.google.firebase.firestore.pipeline.Expr expr);
+    method public static com.google.firebase.firestore.pipeline.AggregateFunction count(com.google.firebase.firestore.pipeline.Expr expression);
     method public static com.google.firebase.firestore.pipeline.AggregateFunction count(String fieldName);
     method public static com.google.firebase.firestore.pipeline.AggregateFunction countAll();
     method public static com.google.firebase.firestore.pipeline.AggregateFunction countIf(com.google.firebase.firestore.pipeline.BooleanExpr condition);
     method public static com.google.firebase.firestore.pipeline.AggregateFunction generic(String name, com.google.firebase.firestore.pipeline.Expr... expr);
-    method public static com.google.firebase.firestore.pipeline.AggregateFunction max(com.google.firebase.firestore.pipeline.Expr expr);
-    method public static com.google.firebase.firestore.pipeline.AggregateFunction max(String fieldName);
-    method public static com.google.firebase.firestore.pipeline.AggregateFunction min(com.google.firebase.firestore.pipeline.Expr expr);
-    method public static com.google.firebase.firestore.pipeline.AggregateFunction min(String fieldName);
-    method public static com.google.firebase.firestore.pipeline.AggregateFunction sum(com.google.firebase.firestore.pipeline.Expr expr);
+    method public static com.google.firebase.firestore.pipeline.AggregateFunction maximum(com.google.firebase.firestore.pipeline.Expr expression);
+    method public static com.google.firebase.firestore.pipeline.AggregateFunction maximum(String fieldName);
+    method public static com.google.firebase.firestore.pipeline.AggregateFunction minimum(com.google.firebase.firestore.pipeline.Expr expression);
+    method public static com.google.firebase.firestore.pipeline.AggregateFunction minimum(String fieldName);
+    method public static com.google.firebase.firestore.pipeline.AggregateFunction sum(com.google.firebase.firestore.pipeline.Expr expression);
     method public static com.google.firebase.firestore.pipeline.AggregateFunction sum(String fieldName);
     field public static final com.google.firebase.firestore.pipeline.AggregateFunction.Companion Companion;
   }
 
   public static final class AggregateFunction.Companion {
-    method public com.google.firebase.firestore.pipeline.AggregateFunction avg(com.google.firebase.firestore.pipeline.Expr expr);
+    method public com.google.firebase.firestore.pipeline.AggregateFunction avg(com.google.firebase.firestore.pipeline.Expr expression);
     method public com.google.firebase.firestore.pipeline.AggregateFunction avg(String fieldName);
-    method public com.google.firebase.firestore.pipeline.AggregateFunction count(com.google.firebase.firestore.pipeline.Expr expr);
+    method public com.google.firebase.firestore.pipeline.AggregateFunction count(com.google.firebase.firestore.pipeline.Expr expression);
     method public com.google.firebase.firestore.pipeline.AggregateFunction count(String fieldName);
     method public com.google.firebase.firestore.pipeline.AggregateFunction countAll();
     method public com.google.firebase.firestore.pipeline.AggregateFunction countIf(com.google.firebase.firestore.pipeline.BooleanExpr condition);
     method public com.google.firebase.firestore.pipeline.AggregateFunction generic(String name, com.google.firebase.firestore.pipeline.Expr... expr);
-    method public com.google.firebase.firestore.pipeline.AggregateFunction max(com.google.firebase.firestore.pipeline.Expr expr);
-    method public com.google.firebase.firestore.pipeline.AggregateFunction max(String fieldName);
-    method public com.google.firebase.firestore.pipeline.AggregateFunction min(com.google.firebase.firestore.pipeline.Expr expr);
-    method public com.google.firebase.firestore.pipeline.AggregateFunction min(String fieldName);
-    method public com.google.firebase.firestore.pipeline.AggregateFunction sum(com.google.firebase.firestore.pipeline.Expr expr);
+    method public com.google.firebase.firestore.pipeline.AggregateFunction maximum(com.google.firebase.firestore.pipeline.Expr expression);
+    method public com.google.firebase.firestore.pipeline.AggregateFunction maximum(String fieldName);
+    method public com.google.firebase.firestore.pipeline.AggregateFunction minimum(com.google.firebase.firestore.pipeline.Expr expression);
+    method public com.google.firebase.firestore.pipeline.AggregateFunction minimum(String fieldName);
+    method public com.google.firebase.firestore.pipeline.AggregateFunction sum(com.google.firebase.firestore.pipeline.Expr expression);
     method public com.google.firebase.firestore.pipeline.AggregateFunction sum(String fieldName);
   }
 
@@ -738,8 +738,8 @@ package com.google.firebase.firestore.pipeline {
   }
 
   public class BooleanExpr extends com.google.firebase.firestore.pipeline.FunctionExpr {
-    method public final com.google.firebase.firestore.pipeline.Expr cond(com.google.firebase.firestore.pipeline.Expr then, com.google.firebase.firestore.pipeline.Expr otherwise);
-    method public final com.google.firebase.firestore.pipeline.Expr cond(Object then, Object otherwise);
+    method public final com.google.firebase.firestore.pipeline.Expr cond(com.google.firebase.firestore.pipeline.Expr thenExpr, com.google.firebase.firestore.pipeline.Expr elseExpr);
+    method public final com.google.firebase.firestore.pipeline.Expr cond(Object thenValue, Object elseValue);
     method public final com.google.firebase.firestore.pipeline.AggregateFunction countIf();
     method public static final com.google.firebase.firestore.pipeline.BooleanExpr generic(String name, com.google.firebase.firestore.pipeline.Expr... expr);
     method public final com.google.firebase.firestore.pipeline.BooleanExpr not();
@@ -1062,8 +1062,8 @@ package com.google.firebase.firestore.pipeline {
     method public final com.google.firebase.firestore.pipeline.Expr mapRemove(String key);
     method public static final com.google.firebase.firestore.pipeline.Expr mapRemove(String mapField, com.google.firebase.firestore.pipeline.Expr key);
     method public static final com.google.firebase.firestore.pipeline.Expr mapRemove(String mapField, String key);
-    method public final com.google.firebase.firestore.pipeline.AggregateFunction max();
-    method public final com.google.firebase.firestore.pipeline.AggregateFunction min();
+    method public final com.google.firebase.firestore.pipeline.AggregateFunction maximum();
+    method public final com.google.firebase.firestore.pipeline.AggregateFunction minimum();
     method public final com.google.firebase.firestore.pipeline.Expr mod(com.google.firebase.firestore.pipeline.Expr divisor);
     method public static final com.google.firebase.firestore.pipeline.Expr mod(com.google.firebase.firestore.pipeline.Expr dividend, com.google.firebase.firestore.pipeline.Expr divisor);
     method public static final com.google.firebase.firestore.pipeline.Expr mod(com.google.firebase.firestore.pipeline.Expr dividend, Number divisor);
@@ -1194,18 +1194,18 @@ package com.google.firebase.firestore.pipeline {
     method public static final com.google.firebase.firestore.pipeline.Expr trim(com.google.firebase.firestore.pipeline.Expr stringExpression);
     method public static final com.google.firebase.firestore.pipeline.Expr trim(String fieldName);
     method public final com.google.firebase.firestore.pipeline.Expr unixMicrosToTimestamp();
-    method public static final com.google.firebase.firestore.pipeline.Expr unixMicrosToTimestamp(com.google.firebase.firestore.pipeline.Expr input);
+    method public static final com.google.firebase.firestore.pipeline.Expr unixMicrosToTimestamp(com.google.firebase.firestore.pipeline.Expr expr);
     method public static final com.google.firebase.firestore.pipeline.Expr unixMicrosToTimestamp(String fieldName);
     method public final com.google.firebase.firestore.pipeline.Expr unixMillisToTimestamp();
     method public static final com.google.firebase.firestore.pipeline.Expr unixMillisToTimestamp(com.google.firebase.firestore.pipeline.Expr expr);
     method public static final com.google.firebase.firestore.pipeline.Expr unixMillisToTimestamp(String fieldName);
     method public final com.google.firebase.firestore.pipeline.Expr unixSecondsToTimestamp();
-    method public static final com.google.firebase.firestore.pipeline.Expr unixSecondsToTimestamp(com.google.firebase.firestore.pipeline.Expr input);
+    method public static final com.google.firebase.firestore.pipeline.Expr unixSecondsToTimestamp(com.google.firebase.firestore.pipeline.Expr expr);
     method public static final com.google.firebase.firestore.pipeline.Expr unixSecondsToTimestamp(String fieldName);
     method public static final com.google.firebase.firestore.pipeline.Expr vector(com.google.firebase.firestore.VectorValue vector);
     method public static final com.google.firebase.firestore.pipeline.Expr vector(double[] vector);
     method public final com.google.firebase.firestore.pipeline.Expr vectorLength();
-    method public static final com.google.firebase.firestore.pipeline.Expr vectorLength(com.google.firebase.firestore.pipeline.Expr vector);
+    method public static final com.google.firebase.firestore.pipeline.Expr vectorLength(com.google.firebase.firestore.pipeline.Expr vectorExpression);
     method public static final com.google.firebase.firestore.pipeline.Expr vectorLength(String fieldName);
     method public static final com.google.firebase.firestore.pipeline.BooleanExpr xor(com.google.firebase.firestore.pipeline.BooleanExpr condition, com.google.firebase.firestore.pipeline.BooleanExpr... conditions);
     field public static final com.google.firebase.firestore.pipeline.Expr.Companion Companion;
@@ -1456,15 +1456,15 @@ package com.google.firebase.firestore.pipeline {
     method public com.google.firebase.firestore.pipeline.Expr toUpper(String fieldName);
     method public com.google.firebase.firestore.pipeline.Expr trim(com.google.firebase.firestore.pipeline.Expr stringExpression);
     method public com.google.firebase.firestore.pipeline.Expr trim(String fieldName);
-    method public com.google.firebase.firestore.pipeline.Expr unixMicrosToTimestamp(com.google.firebase.firestore.pipeline.Expr input);
+    method public com.google.firebase.firestore.pipeline.Expr unixMicrosToTimestamp(com.google.firebase.firestore.pipeline.Expr expr);
     method public com.google.firebase.firestore.pipeline.Expr unixMicrosToTimestamp(String fieldName);
     method public com.google.firebase.firestore.pipeline.Expr unixMillisToTimestamp(com.google.firebase.firestore.pipeline.Expr expr);
     method public com.google.firebase.firestore.pipeline.Expr unixMillisToTimestamp(String fieldName);
-    method public com.google.firebase.firestore.pipeline.Expr unixSecondsToTimestamp(com.google.firebase.firestore.pipeline.Expr input);
+    method public com.google.firebase.firestore.pipeline.Expr unixSecondsToTimestamp(com.google.firebase.firestore.pipeline.Expr expr);
     method public com.google.firebase.firestore.pipeline.Expr unixSecondsToTimestamp(String fieldName);
     method public com.google.firebase.firestore.pipeline.Expr vector(com.google.firebase.firestore.VectorValue vector);
     method public com.google.firebase.firestore.pipeline.Expr vector(double[] vector);
-    method public com.google.firebase.firestore.pipeline.Expr vectorLength(com.google.firebase.firestore.pipeline.Expr vector);
+    method public com.google.firebase.firestore.pipeline.Expr vectorLength(com.google.firebase.firestore.pipeline.Expr vectorExpression);
     method public com.google.firebase.firestore.pipeline.Expr vectorLength(String fieldName);
     method public com.google.firebase.firestore.pipeline.BooleanExpr xor(com.google.firebase.firestore.pipeline.BooleanExpr condition, com.google.firebase.firestore.pipeline.BooleanExpr... conditions);
   }

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/PipelineTest.java

@@ -244,7 +244,7 @@ public void aggregateResultsMany() {
             .aggregate(
                 AggregateFunction.countAll().alias("count"),
                 AggregateFunction.avg("rating").alias("avgRating"),
-                field("rating").max().alias("maxRating"))
+                field("rating").maximum().alias("maxRating"))
             .execute();
     assertThat(waitFor(execute).getResults())
         .comparingElementsUsing(DATA_CORRESPONDENCE)
@@ -304,8 +304,8 @@ public void minAndMaxAccumulations() {
             .collection(randomCol)
             .aggregate(
                 AggregateFunction.countAll().alias("count"),
-                field("rating").max().alias("maxRating"),
-                field("published").min().alias("minPublished"))
+                field("rating").maximum().alias("maxRating"),
+                field("published").minimum().alias("minPublished"))
             .execute();
     assertThat(waitFor(execute).getResults())
         .comparingElementsUsing(DATA_CORRESPONDENCE)

firebase-firestore/src/main/java/com/google/firebase/firestore/pipeline/aggregates.kt

@@ -35,29 +35,108 @@ private constructor(
 
     @JvmStatic fun generic(name: String, vararg expr: Expr) = AggregateFunction(name, expr)
 
+    /**
+     * Creates an aggregation that counts the total number of stage inputs.
+     *
+     * @return A new [AggregateFunction] representing the countAll aggregation.
+     */
     @JvmStatic fun countAll() = AggregateFunction("count")
 
+    /**
+     * Creates an aggregation that counts the number of stage inputs where the input field exists.
+     *
+     * @param fieldName The name of the field to count.
+     * @return A new [AggregateFunction] representing the 'count' aggregation.
+     */
     @JvmStatic fun count(fieldName: String) = AggregateFunction("count", fieldName)
 
-    @JvmStatic fun count(expr: Expr) = AggregateFunction("count", expr)
-
+    /**
+     * Creates an aggregation that counts the number of stage inputs with valid evaluations of the
+     * provided [expression].
+     *
+     * @param expression The expression to count.
+     * @return A new [AggregateFunction] representing the 'count' aggregation.
+     */
+    @JvmStatic fun count(expression: Expr) = AggregateFunction("count", expression)
+
+    /**
+     * Creates an aggregation that counts the number of stage inputs where the provided boolean
+     * expression evaluates to true.
+     *
+     * @param condition The boolean expression to evaluate on each input.
+     * @return A new [AggregateFunction] representing the count aggregation.
+     */
     @JvmStatic fun countIf(condition: BooleanExpr) = AggregateFunction("countIf", condition)
 
+    /**
+     * Creates an aggregation that calculates the sum of a field's values across multiple stage
+     * inputs.
+     *
+     * @param fieldName The name of the field containing numeric values to sum up.
+     * @return A new [AggregateFunction] representing the average aggregation.
+     */
     @JvmStatic fun sum(fieldName: String) = AggregateFunction("sum", fieldName)
 
-    @JvmStatic fun sum(expr: Expr) = AggregateFunction("sum", expr)
-
+    /**
+     * Creates an aggregation that calculates the sum of values from an expression across multiple
+     * stage inputs.
+     *
+     * @param expression The expression to sum up.
+     * @return A new [AggregateFunction] representing the sum aggregation.
+     */
+    @JvmStatic fun sum(expression: Expr) = AggregateFunction("sum", expression)
+
+    /**
+     * Creates an aggregation that calculates the average (mean) of a field's values across multiple
+     * stage inputs.
+     *
+     * @param fieldName The name of the field containing numeric values to average.
+     * @return A new [AggregateFunction] representing the average aggregation.
+     */
     @JvmStatic fun avg(fieldName: String) = AggregateFunction("avg", fieldName)
 
-    @JvmStatic fun avg(expr: Expr) = AggregateFunction("avg", expr)
-
-    @JvmStatic fun min(fieldName: String) = AggregateFunction("min", fieldName)
-
-    @JvmStatic fun min(expr: Expr) = AggregateFunction("min", expr)
-
-    @JvmStatic fun max(fieldName: String) = AggregateFunction("max", fieldName)
-
-    @JvmStatic fun max(expr: Expr) = AggregateFunction("max", expr)
+    /**
+     * Creates an aggregation that calculates the average (mean) of values from an expression across
+     * multiple stage inputs.
+     *
+     * @param expression The expression representing the values to average.
+     * @return A new [AggregateFunction] representing the average aggregation.
+     */
+    @JvmStatic fun avg(expression: Expr) = AggregateFunction("avg", expression)
+
+    /**
+     * Creates an aggregation that finds the minimum value of a field across multiple stage inputs.
+     *
+     * @param fieldName The name of the field to find the minimum value of.
+     * @return A new [AggregateFunction] representing the minimum aggregation.
+     */
+    @JvmStatic fun minimum(fieldName: String) = AggregateFunction("min", fieldName)
+
+    /**
+     * Creates an aggregation that finds the minimum value of an expression across multiple stage
+     * inputs.
+     *
+     * @param expression The expression to find the minimum value of.
+     * @return A new [AggregateFunction] representing the minimum aggregation.
+     */
+    @JvmStatic fun minimum(expression: Expr) = AggregateFunction("min", expression)
+
+    /**
+     * Creates an aggregation that finds the maximum value of a field across multiple stage inputs.
+     *
+     * @param fieldName The name of the field to find the maximum value of.
+     * @return A new [AggregateFunction] representing the maximum aggregation.
+     */
+    @JvmStatic fun maximum(fieldName: String) = AggregateFunction("max", fieldName)
+
+    /**
+     * Creates an aggregation that finds the maximum value of an expression across multiple stage
+     * inputs.
+     *
+     * @param expression The expression to find the maximum value of.
+     * @return A new [AggregateFunction] representing the maximum aggregation.
+     */
+    @JvmStatic fun maximum(expression: Expr) = AggregateFunction("max", expression)
   }
 
   /**