Function and stage renames

Author: wu-hui

google-cloud-firestore/src/main/java/com/google/cloud/firestore/AggregateQuery.java

@@ -67,9 +67,9 @@ public Query getQuery() {
   }
 
   @Nonnull
-  public Pipeline toPipeline() {
+  public Pipeline pipeline() {
     return getQuery()
-        .toPipeline()
+        .pipeline()
         .aggregate(
             this.aggregateFieldList.stream()
                 .map(PipelineUtils::toPipelineAggregatorTarget)

google-cloud-firestore/src/main/java/com/google/cloud/firestore/Firestore.java

@@ -66,6 +66,8 @@ public interface Firestore extends Service<FirestoreOptions>, AutoCloseable {
    */
   CollectionGroup collectionGroup(@Nonnull String collectionId);
 
+  PipelineSource pipeline();
+
   /**
    * Executes the given updateFunction and then attempts to commit the changes applied within the
    * transaction. If any document read within the transaction has changed, the updateFunction will

google-cloud-firestore/src/main/java/com/google/cloud/firestore/FirestoreImpl.java

@@ -18,6 +18,7 @@
 
 import com.google.api.core.ApiClock;
 import com.google.api.core.ApiFuture;
+import com.google.api.core.BetaApi;
 import com.google.api.core.NanoClock;
 import com.google.api.core.SettableApiFuture;
 import com.google.api.gax.rpc.ApiStreamObserver;
@@ -385,6 +386,13 @@ public CollectionGroup collectionGroup(@Nonnull final String collectionId) {
     return new CollectionGroup(this, collectionId);
   }
 
+  @Nonnull
+  @Override
+  @BetaApi
+  public PipelineSource pipeline() {
+    return new PipelineSource();
+  }
+
   @Nonnull
   @Override
   public <T> ApiFuture<T> runTransaction(@Nonnull final Function<T> updateFunction) {

google-cloud-firestore/src/main/java/com/google/cloud/firestore/Pipeline.java

@@ -29,7 +29,7 @@
 import com.google.cloud.firestore.pipeline.stages.Sort;
 import com.google.cloud.firestore.pipeline.stages.Stage;
 import com.google.cloud.firestore.pipeline.stages.StageUtils;
-import com.google.common.base.Preconditions;
+import com.google.cloud.firestore.pipeline.stages.Where;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.Lists;
@@ -88,42 +88,22 @@ private Pipeline(List<Stage> stages) {
     this.stages = ImmutableList.copyOf(stages);
   }
 
-  private Pipeline(Collection collection) {
+  Pipeline(Collection collection) {
     this(Lists.newArrayList(collection));
   }
 
-  private Pipeline(CollectionGroup group) {
+  Pipeline(CollectionGroup group) {
     this(Lists.newArrayList(group));
   }
 
-  private Pipeline(Database db) {
+  Pipeline(Database db) {
     this(Lists.newArrayList(db));
   }
 
-  private Pipeline(Documents docs) {
+  Pipeline(Documents docs) {
     this(Lists.newArrayList(docs));
   }
 
-  public static Pipeline fromCollection(String collectionName) {
-    return new Pipeline(new Collection(collectionName));
-  }
-
-  public static Pipeline fromCollectionGroup(String collectionId) {
-    Preconditions.checkArgument(
-        !collectionId.contains("/"),
-        "Invalid collectionId '%s'. Collection IDs must not contain '/'.",
-        collectionId);
-    return new Pipeline(new CollectionGroup(collectionId));
-  }
-
-  public static Pipeline fromDatabase() {
-    return new Pipeline(new Database());
-  }
-
-  public static Pipeline fromDocuments(DocumentReference... docs) {
-    return new Pipeline(Documents.of(docs));
-  }
-
   private Map<String, Expr> projectablesToMap(Selectable... selectables) {
     Map<String, Expr> projMap = new HashMap<>();
     for (Selectable proj : selectables) {
@@ -178,12 +158,9 @@ public Pipeline select(String... fields) {
             .build());
   }
 
-  public Pipeline filter(FilterCondition condition) {
+  public Pipeline where(FilterCondition condition) {
     return new Pipeline(
-        ImmutableList.<Stage>builder()
-            .addAll(stages)
-            .add(new com.google.cloud.firestore.pipeline.stages.Filter(condition))
-            .build());
+        ImmutableList.<Stage>builder().addAll(stages).add(new Where(condition)).build());
   }
 
   public Pipeline offset(int offset) {

google-cloud-firestore/src/main/java/com/google/cloud/firestore/PipelineSource.java

@@ -0,0 +1,35 @@
+package com.google.cloud.firestore;
+
+import com.google.cloud.firestore.pipeline.stages.Collection;
+import com.google.cloud.firestore.pipeline.stages.CollectionGroup;
+import com.google.cloud.firestore.pipeline.stages.Database;
+import com.google.cloud.firestore.pipeline.stages.Documents;
+import com.google.common.base.Preconditions;
+import javax.annotation.Nonnull;
+
+public class PipelineSource {
+
+  @Nonnull
+  public Pipeline collection(@Nonnull String path) {
+    return new Pipeline(new Collection(path));
+  }
+
+  @Nonnull
+  public Pipeline collectionGroup(@Nonnull String collectionId) {
+    Preconditions.checkArgument(
+        !collectionId.contains("/"),
+        "Invalid collectionId '%s'. Collection IDs must not contain '/'.",
+        collectionId);
+    return new Pipeline(new CollectionGroup(collectionId));
+  }
+
+  @Nonnull
+  public Pipeline database() {
+    return new Pipeline(new Database());
+  }
+
+  @Nonnull
+  public Pipeline documents(DocumentReference... docs) {
+    return new Pipeline(Documents.of(docs));
+  }
+}

google-cloud-firestore/src/main/java/com/google/cloud/firestore/PipelineUtils.java

@@ -38,17 +38,17 @@ static FilterCondition toPipelineFilterCondition(FilterInternal f) {
       Value value = comparisonFilter.value;
       switch (comparisonFilter.operator) {
         case LESS_THAN:
-          return Field.of(fieldPath).lessThan(value);
+          return Field.of(fieldPath).lt(value);
         case LESS_THAN_OR_EQUAL:
-          return Field.of(fieldPath).lessThanOrEqual(value);
+          return Field.of(fieldPath).lte(value);
         case GREATER_THAN:
-          return Field.of(fieldPath).greaterThan(value);
+          return Field.of(fieldPath).gt(value);
         case GREATER_THAN_OR_EQUAL:
-          return Field.of(fieldPath).greaterThanOrEqual(value);
+          return Field.of(fieldPath).gte(value);
         case EQUAL:
-          return Field.of(fieldPath).equal(value);
+          return Field.of(fieldPath).eq(value);
         case NOT_EQUAL:
-          return not(Field.of(fieldPath).equal(value));
+          return not(Field.of(fieldPath).eq(value));
         case ARRAY_CONTAINS:
           return Field.of(fieldPath).arrayContains(value);
         case IN:

google-cloud-firestore/src/main/java/com/google/cloud/firestore/Query.java

@@ -2122,17 +2122,18 @@ public AggregateQuery aggregate(
   }
 
   @Nonnull
-  public Pipeline toPipeline() {
+  public Pipeline pipeline() {
     // From
     Pipeline ppl =
         this.options.getAllDescendants()
-            ? Pipeline.fromCollectionGroup(this.options.getCollectionId())
-            : Pipeline.fromCollection(
-                this.options.getParentPath().append(this.options.getCollectionId()).getPath());
+            ? new PipelineSource().collectionGroup(this.options.getCollectionId())
+            : new PipelineSource()
+                .collection(
+                    this.options.getParentPath().append(this.options.getCollectionId()).getPath());
 
     // Filters
     for (FilterInternal f : this.options.getFilters()) {
-      ppl = ppl.filter(toPipelineFilterCondition(f));
+      ppl = ppl.where(toPipelineFilterCondition(f));
     }
 
     // Projections
@@ -2167,10 +2168,10 @@ public Pipeline toPipeline() {
               .collect(Collectors.toList());
       if (exists.size() > 1) {
         ppl =
-            ppl.filter(
+            ppl.where(
                 and(exists.get(0), exists.subList(1, exists.size()).toArray(new Exists[] {})));
       } else if (exists.size() == 1) {
-        ppl = ppl.filter(exists.get(0));
+        ppl = ppl.where(exists.get(0));
       }
 
       ppl = ppl.sort(orders, Density.REQUIRED, Truncation.UNSPECIFIED);

google-cloud-firestore/src/main/java/com/google/cloud/firestore/pipeline/expressions/Equal.java renamed to google-cloud-firestore/src/main/java/com/google/cloud/firestore/pipeline/expressions/Eq.java

@@ -2,8 +2,8 @@
 
 import com.google.common.collect.Lists;
 
-public final class Equal extends Function implements FilterCondition {
-  Equal(Expr left, Expr right) {
+public final class Eq extends Function implements FilterCondition {
+  Eq(Expr left, Expr right) {
     super("eq", Lists.newArrayList(left, right));
   }
 }

google-cloud-firestore/src/main/java/com/google/cloud/firestore/pipeline/expressions/Expr.java

@@ -37,52 +37,52 @@ default Divide divide(Object other) {
     return new Divide(this, Constant.of(other));
   }
 
-  default Equal equal(Expr expr) {
-    return new Equal(this, expr);
+  default Eq eq(Expr expr) {
+    return new Eq(this, expr);
   }
 
-  default Equal equal(Object other) {
-    return new Equal(this, Constant.of(other));
+  default Eq eq(Object other) {
+    return new Eq(this, Constant.of(other));
   }
 
-  default NotEqual notEqual(Expr other) {
-    return new NotEqual(this, other);
+  default Neq neq(Expr other) {
+    return new Neq(this, other);
   }
 
-  default NotEqual notEqual(Object other) {
-    return new NotEqual(this, Constant.of(other));
+  default Neq neq(Object other) {
+    return new Neq(this, Constant.of(other));
   }
 
-  default GreaterThan greaterThan(Expr other) {
-    return new GreaterThan(this, other);
+  default Gt gt(Expr other) {
+    return new Gt(this, other);
   }
 
-  default GreaterThan greaterThan(Object other) {
-    return new GreaterThan(this, Constant.of(other));
+  default Gt gt(Object other) {
+    return new Gt(this, Constant.of(other));
   }
 
-  default GreaterThanOrEqual greaterThanOrEqual(Expr other) {
-    return new GreaterThanOrEqual(this, other);
+  default Gte gte(Expr other) {
+    return new Gte(this, other);
   }
 
-  default GreaterThanOrEqual greaterThanOrEqual(Object other) {
-    return new GreaterThanOrEqual(this, Constant.of(other));
+  default Gte gte(Object other) {
+    return new Gte(this, Constant.of(other));
   }
 
-  default LessThan lessThan(Expr other) {
-    return new LessThan(this, other);
+  default Lt lt(Expr other) {
+    return new Lt(this, other);
   }
 
-  default LessThan lessThan(Object other) {
-    return new LessThan(this, Constant.of(other));
+  default Lt lt(Object other) {
+    return new Lt(this, Constant.of(other));
   }
 
-  default LessThanOrEqual lessThanOrEqual(Expr other) {
-    return new LessThanOrEqual(this, other);
+  default Lte lte(Expr other) {
+    return new Lte(this, other);
   }
 
-  default LessThanOrEqual lessThanOrEqual(Object other) {
-    return new LessThanOrEqual(this, Constant.of(other));
+  default Lte lte(Object other) {
+    return new Lte(this, Constant.of(other));
   }
 
   default In inAny(Object... other) {
@@ -184,6 +184,10 @@ default RegexContains regexContains(String regex) {
     return new RegexContains(this, Constant.of(regex));
   }
 
+  default RegexMatch regexMatches(String regex) {
+    return new RegexMatch(this, Constant.of(regex));
+  }
+
   default StrConcat strConcat(List<Expr> elements) {
     return new StrConcat(this, elements);
   }