[WIP] Expose query constrains on the public Query class #178
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| package com.google.firebase.firestore; | ||
|
|
||
| import com.google.firebase.annotations.PublicApi; | ||
| import com.google.firebase.firestore.core.NaNFilter; | ||
| import com.google.firebase.firestore.core.NullFilter; | ||
| import com.google.firebase.firestore.core.RelationFilter; | ||
|
|
||
| import javax.annotation.Nullable; | ||
|
|
||
| @PublicApi | ||
| public final class Filter { | ||
|
|
||
| @PublicApi | ||
| public enum Operator { | ||
| LESS_THAN("<"), | ||
| LESS_THAN_OR_EQUAL("<="), | ||
| EQUAL("=="), | ||
| GREATER_THAN(">"), | ||
| GREATER_THAN_OR_EQUAL(">="), | ||
| ARRAY_CONTAINS("array_contains"); | ||
|
|
||
| private final String text; | ||
|
|
||
| Operator(String text) { | ||
| this.text = text; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return text; | ||
| } | ||
| } | ||
|
|
||
| private final com.google.firebase.firestore.core.Filter filter; | ||
|
|
||
| /** Initializes a filter */ | ||
| public Filter(com.google.firebase.firestore.core.Filter filter) { | ||
| this.filter = filter; | ||
| } | ||
|
|
||
| @PublicApi | ||
| public boolean isRelationFilter() { | ||
| return filter instanceof RelationFilter; | ||
| } | ||
|
|
||
| @PublicApi | ||
| public String getFieldPath() { | ||
| return filter.getField().canonicalString(); | ||
| } | ||
|
|
||
| @Nullable | ||
| @PublicApi | ||
| public Operator getOperator() { | ||
| if (isRelationFilter()) { | ||
| return ((RelationFilter) filter).getOperator(); | ||
| } else { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| @Nullable | ||
| @PublicApi | ||
| public Object getFieldValue() { | ||
| if (filter instanceof NaNFilter) { | ||
| return Double.NaN; | ||
| } else { | ||
| if (isRelationFilter()) { | ||
| return ((RelationFilter) filter).getValue().value(); | ||
| } else { | ||
| return null; | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,8 +29,7 @@ | |
| import com.google.firebase.firestore.core.Bound; | ||
| import com.google.firebase.firestore.core.EventManager.ListenOptions; | ||
| import com.google.firebase.firestore.core.Filter; | ||
| import com.google.firebase.firestore.Filter.Operator; | ||
| import com.google.firebase.firestore.core.QueryListener; | ||
| import com.google.firebase.firestore.core.RelationFilter; | ||
| import com.google.firebase.firestore.core.ViewSnapshot; | ||
|
|
@@ -900,6 +899,47 @@ private ListenerRegistration addSnapshotListenerInternal( | |
| firestore.getClient(), queryListener, activity, wrappedListener); | ||
| } | ||
|
|
||
| @PublicApi | ||
| public String getPath() { | ||
|
There was a problem hiding this comment. Note to self: It's tempting to use a CollectionReference here but that only works for collection queries, not the soon-to-be-added "collection group" queries which are rooted at a document path. Still, it would be nice to avoid exposing just a raw string path. There was a problem hiding this comment. Note to self: We need to figure out how we want to expose Collection Group queries (#233) in general. |
||
| return query.getPath().canonicalString(); | ||
| } | ||
|
|
||
| @PublicApi | ||
| public List<com.google.firebase.firestore.Filter> getFilters() { | ||
|
There was a problem hiding this comment. Note to self: Since we're exposing filters as |
||
| com.google.firebase.firestore.Filter newFilter; | ||
| List<com.google.firebase.firestore.Filter> filters = new ArrayList<>(); | ||
| for (Filter filter : query.getFilters()) { | ||
| newFilter = new com.google.firebase.firestore.Filter(filter); | ||
| filters.add(newFilter); | ||
| } | ||
| return filters; | ||
| } | ||
|
|
||
| @PublicApi | ||
| public List<OrderBy> getOrderBy() { | ||
| return query.getExplicitOrderBy(); | ||
| } | ||
|
|
||
| @PublicApi | ||
| public boolean hasLimit() { | ||
| return query.hasLimit(); | ||
| } | ||
|
|
||
| @PublicApi | ||
| public long getLimit() { | ||
| return query.getLimit(); | ||
|
There was a problem hiding this comment. Note to myself: It's tempting to drop |
||
| } | ||
|
|
||
| @PublicApi | ||
| public @Nullable String getStartAt() { | ||
|
There was a problem hiding this comment. I think getStartAt() / getEndAt() need to return |
||
| return query.getStartAt().getFieldValue(); | ||
| } | ||
|
|
||
| @PublicApi | ||
| public @Nullable String getEndAt() { | ||
| return query.getEndAt().getFieldValue(); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Returning the field path as a
Stringhere using.canonicalString()exposes the underlying backend representation of field paths which we don't currently expose in our API, specifically:FieldPath.of("emails", "[email protected]")then the string returned here will be something like"emails.`test@example\.com`"(since we have to escape.when it's contained within a field).FieldPath.documentId()will show up as"__name__"here.I need to discuss this with the team, but I think my suggestion would be to:
FieldPathhere instead ofStringgetSegments()method toFieldPaththat returns a String[] containing the path segments.isDocumentId()method that returns a bool indicating whether the FieldPath is equal toFieldPath.documentId().