Filter class
A helper class to dynamically construct realtime database queries.
You can use one of the three factory constructors of this class, Filter.property, Filter.key or Filter.value to generate a FilterBuilder. This will define how elements are order by the server before filters are applied. You can then use the returned builder to apply filters and finally build the actual filter that can be passed to API methods.
Important: This does not affect the ordering of the received data - after filters have been applied, the data can be returned by the server in any order - if you only (or in addition) need to sort returned data, do so on the client side.
Properties
-
entries
→ Iterable<
MapEntry< String, String> > -
The map entries of this.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- isEmpty → bool
-
Whether there is no key/value pair in the map.
no setterinherited
- isNotEmpty → bool
-
Whether there is at least one key/value pair in the map.
no setterinherited
-
keys
→ Iterable<
String> -
The keys of this.
no setteroverride
- length → int
-
The number of key/value pairs in the map.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
values
→ Iterable<
String> -
The values of this.
no setterinherited
Methods
-
addAll(
Map< String, String> other) → void -
This operation is not supported by an unmodifiable map.
inherited
-
addEntries(
Iterable< MapEntry< entries) → voidString, String> > -
This operation is not supported by an unmodifiable map.
inherited
-
cast<
RK, RV> () → Map< RK, RV> -
Provides a view of this map as having
RK
keys andRV
instances, if necessary.inherited -
clear(
) → void -
This operation is not supported by an unmodifiable map.
inherited
-
containsKey(
Object? key) → bool -
Whether this map contains the given
key
.inherited -
containsValue(
Object? value) → bool -
Whether this map contains the given
value
.inherited -
forEach(
void action(String key, String value)) → void -
Applies
action
to each key/value pair of the map.inherited -
map<
K2, V2> (MapEntry< K2, V2> transform(String key, String value)) → Map<K2, V2> -
Returns a new map where all entries of this map are transformed by
the given
convert
function.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
putIfAbsent(
String key, String ifAbsent()) → String -
This operation is not supported by an unmodifiable map.
inherited
-
remove(
Object? key) → String? -
This operation is not supported by an unmodifiable map.
inherited
-
removeWhere(
bool test(String key, String value)) → void -
This operation is not supported by an unmodifiable map.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
update(
String key, String update(String value), {String ifAbsent()?}) → String -
This operation is not supported by an unmodifiable map.
inherited
-
updateAll(
String update(String key, String value)) → void -
This operation is not supported by an unmodifiable map.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator [](
covariant String key) → String? -
The value for the given
key
, ornull
ifkey
is not in the map.override -
operator []=(
String key, String value) → void -
This operation is not supported by an unmodifiable map.
inherited
Static Methods
-
key(
) → FilterBuilder< String> - Order elements by their key before filtering them.
-
property<
T> (String property) → FilterBuilder< T> - Order elements by a certain child value before filtering them.
-
value<
T> () → FilterBuilder< T> - Order elements by their value before filtering them.