feat: Support for Composite Filters. (#975)

* Support for Composite Filters. * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Minor fixes. * Remove commented code. * Better names? * Update license format. * Prefer `equals` to `==` for enum comparison. * We must throw an error if Null or NaN is used in anything other than == or !=. * Use Nunnull, not NonNull. * Add tests. * Remove unrelated comment. * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Author: ehsannas

README.md

@@ -49,20 +49,20 @@ If you are using Maven without BOM, add this to your dependencies:
 If you are using Gradle 5.x or later, add this to your dependencies
 
 ```Groovy
-implementation platform('com.google.cloud:libraries-bom:25.4.0')
+implementation platform('com.google.cloud:libraries-bom:26.0.0')
 
 implementation 'com.google.cloud:google-cloud-firestore'
 ```
 If you are using Gradle without BOM, add this to your dependencies
 
 ```Groovy
-implementation 'com.google.cloud:google-cloud-firestore:3.2.0'
+implementation 'com.google.cloud:google-cloud-firestore:3.3.0'
 ```
 
 If you are using SBT, add this to your dependencies
 
 ```Scala
-libraryDependencies += "com.google.cloud" % "google-cloud-firestore" % "3.2.0"
+libraryDependencies += "com.google.cloud" % "google-cloud-firestore" % "3.3.0"
 ```
 
 ## Authentication

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

@@ -0,0 +1,184 @@
+/*
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.cloud.firestore;
+
+import com.google.firestore.v1.StructuredQuery;
+import com.google.firestore.v1.StructuredQuery.FieldFilter.Operator;
+import java.util.Arrays;
+import java.util.List;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+/** @hide */
+public class Filter {
+ static class UnaryFilter extends Filter {
+ private final FieldPath field;
+ private final Operator operator;
+ private final Object value;
+
+ public UnaryFilter(FieldPath field, Operator operator, @Nullable Object value) {
+ this.field = field;
+ this.operator = operator;
+ this.value = value;
+ }
+
+ public FieldPath getField() {
+ return field;
+ }
+
+ public Operator getOperator() {
+ return operator;
+ }
+
+ @Nullable
+ public Object getValue() {
+ return value;
+ }
+ }
+
+ static class CompositeFilter extends Filter {
+ private final List<Filter> filters;
+ private final StructuredQuery.CompositeFilter.Operator operator;
+
+ public CompositeFilter(
+ @Nonnull List<Filter> filters, StructuredQuery.CompositeFilter.Operator operator) {
+ this.filters = filters;
+ this.operator = operator;
+ }
+
+ public List<Filter> getFilters() {
+ return filters;
+ }
+
+ public StructuredQuery.CompositeFilter.Operator getOperator() {
+ return operator;
+ }
+ }
+
+ @Nonnull
+ public static Filter equalTo(@Nonnull String field, @Nullable Object value) {
+ return equalTo(FieldPath.fromDotSeparatedString(field), value);
+ }
+
+ @Nonnull
+ public static Filter equalTo(@Nonnull FieldPath fieldPath, @Nullable Object value) {
+ return new UnaryFilter(fieldPath, Operator.EQUAL, value);
+ }
+
+ @Nonnull
+ public static Filter notEqualTo(@Nonnull String field, @Nullable Object value) {
+ return notEqualTo(FieldPath.fromDotSeparatedString(field), value);
+ }
+
+ @Nonnull
+ public static Filter notEqualTo(@Nonnull FieldPath fieldPath, @Nullable Object value) {
+ return new UnaryFilter(fieldPath, Operator.NOT_EQUAL, value);
+ }
+
+ @Nonnull
+ public static Filter greaterThan(@Nonnull String field, @Nullable Object value) {
+ return greaterThan(FieldPath.fromDotSeparatedString(field), value);
+ }
+
+ @Nonnull
+ public static Filter greaterThan(@Nonnull FieldPath fieldPath, @Nullable Object value) {
+ return new UnaryFilter(fieldPath, Operator.GREATER_THAN, value);
+ }
+
+ @Nonnull
+ public static Filter greaterThanOrEqualTo(@Nonnull String field, @Nullable Object value) {
+ return greaterThanOrEqualTo(FieldPath.fromDotSeparatedString(field), value);
+ }
+
+ @Nonnull
+ public static Filter greaterThanOrEqualTo(@Nonnull FieldPath fieldPath, @Nullable Object value) {
+ return new UnaryFilter(fieldPath, Operator.GREATER_THAN_OR_EQUAL, value);
+ }
+
+ @Nonnull
+ public static Filter lessThan(@Nonnull String field, @Nullable Object value) {
+ return lessThan(FieldPath.fromDotSeparatedString(field), value);
+ }
+
+ @Nonnull
+ public static Filter lessThan(@Nonnull FieldPath fieldPath, @Nullable Object value) {
+ return new UnaryFilter(fieldPath, Operator.LESS_THAN, value);
+ }
+
+ @Nonnull
+ public static Filter lessThanOrEqualTo(@Nonnull String field, @Nullable Object value) {
+ return lessThanOrEqualTo(FieldPath.fromDotSeparatedString(field), value);
+ }
+
+ @Nonnull
+ public static Filter lessThanOrEqualTo(@Nonnull FieldPath fieldPath, @Nullable Object value) {
+ return new UnaryFilter(fieldPath, Operator.LESS_THAN_OR_EQUAL, value);
+ }
+
+ @Nonnull
+ public static Filter arrayContains(@Nonnull String field, @Nullable Object value) {
+ return arrayContains(FieldPath.fromDotSeparatedString(field), value);
+ }
+
+ @Nonnull
+ public static Filter arrayContains(@Nonnull FieldPath fieldPath, @Nullable Object value) {
+ return new UnaryFilter(fieldPath, Operator.ARRAY_CONTAINS, value);
+ }
+
+ @Nonnull
+ public static Filter arrayContainsAny(@Nonnull String field, @Nullable Object value) {
+ return arrayContainsAny(FieldPath.fromDotSeparatedString(field), value);
+ }
+
+ @Nonnull
+ public static Filter arrayContainsAny(@Nonnull FieldPath fieldPath, @Nullable Object value) {
+ return new UnaryFilter(fieldPath, Operator.ARRAY_CONTAINS_ANY, value);
+ }
+
+ @Nonnull
+ public static Filter inArray(@Nonnull String field, @Nullable Object value) {
+ return inArray(FieldPath.fromDotSeparatedString(field), value);
+ }
+
+ @Nonnull
+ public static Filter inArray(@Nonnull FieldPath fieldPath, @Nullable Object value) {
+ return new UnaryFilter(fieldPath, Operator.IN, value);
+ }
+
+ @Nonnull
+ public static Filter notInArray(@Nonnull String field, @Nullable Object value) {
+ return notInArray(FieldPath.fromDotSeparatedString(field), value);
+ }
+
+ @Nonnull
+ public static Filter notInArray(@Nonnull FieldPath fieldPath, @Nullable Object value) {
+ return new UnaryFilter(fieldPath, Operator.NOT_IN, value);
+ }
+
+ @Nonnull
+ public static Filter or(Filter... filters) {
+ // TODO(orquery): Change this to Operator.OR once it is available.
+ return new CompositeFilter(
+ Arrays.asList(filters), StructuredQuery.CompositeFilter.Operator.OPERATOR_UNSPECIFIED);
+ }
+
+ @Nonnull
+ public static Filter and(Filter... filters) {
+ return new CompositeFilter(
+ Arrays.asList(filters), StructuredQuery.CompositeFilter.Operator.AND);
+ }
+}