BooleanExpression class abstract

Base class for boolean expressions used in filtering

Inheritance

Constructors

BooleanExpression()

Properties

hashCode → int
The hash code for this object.
no setterinherited
name → String
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

abs() → Expression
Returns the absolute value of this expression
inherited
add(Expression other) → Expression
Adds this expression to another expression
inherited
addNumber(num other) → Expression
Adds a number to this expression
inherited
alias(String alias) → Selectable
Assigns an alias to this expression for use in output
inherited
arrayAgg() → PipelineAggregateFunction
Aggregate: collect values into an array. See ArrayAgg.
inherited
arrayAggDistinct() → PipelineAggregateFunction
Aggregate: collect distinct values into an array. See ArrayAggDistinct.
inherited
arrayConcat(Object? secondArray) → Expression
Concatenates this array with another array expression
inherited
arrayConcatMultiple(List<Object?> otherArrays) → Expression
Concatenates this array with multiple arrays/values
inherited
arrayContainsAll(List<Object?> values) → BooleanExpression
Checks if this array contains all of the given values or expressions
inherited
arrayContainsAllFrom(Expression arrayExpression) → BooleanExpression
Checks if this array contains all elements of arrayExpression (e.g. arrayExpression can be Expression.array of fields/literals).
inherited
arrayContainsAny(List<Object?> values) → BooleanExpression
Checks if this array contains any of the given values or expressions
inherited
arrayContainsElement(Expression element) → BooleanExpression
Checks if this array contains an element expression
inherited
arrayContainsValue(Object? element) → BooleanExpression
Checks if this array contains a value
inherited
arrayFilter(String alias, BooleanExpression filter) → Expression
Filters this array by evaluating filter for each element bound to alias.
inherited
arrayFirst() → Expression
First element of this array expression.
inherited
arrayFirstN(Object? n) → Expression
First n elements of this array expression.
inherited
arrayIndexOf(Object? element) → Expression
Index of the first occurrence of element in this array.
inherited
arrayIndexOfAll(Object? element) → Expression
Array of all indices where element occurs in this array.
inherited
arrayLast() → Expression
Last element of this array expression.
inherited
arrayLastIndexOf(Object? element) → Expression
Index of the last occurrence of element in this array.
inherited
arrayLastN(Object? n) → Expression
Last n elements of this array expression.
inherited
arrayLength() → Expression
Returns the length of this array expression
inherited
arrayMaximum() → Expression
Maximum element of this array (per-document), not the aggregate maximum accumulator.
inherited
arrayMaximumN(Object? n) → Expression
The n largest elements of this array.
inherited
arrayMinimum() → Expression
Minimum element of this array (per-document), not the aggregate minimum accumulator.
inherited
arrayMinimumN(Object? n) → Expression
The n smallest elements of this array.
inherited
arrayReverse() → Expression
Reverses this array expression
inherited
arraySlice(Object? offset, [Object? length]) → Expression
Returns a slice of this array starting at offset.
inherited
arraySum() → Expression
Returns the sum of numeric elements in this array
inherited
arrayTransform(String elementAlias, Expression transform) → Expression
Transforms each element of this array bound to elementAlias.
inherited
arrayTransformWithIndex(String elementAlias, String indexAlias, Expression transform) → Expression
Transforms each element of this array with both element and index aliases.
inherited
as(String alias) → AliasedExpression
Creates an aliased expression
inherited
asBoolean() → BooleanExpression
Casts this expression to a boolean expression
inherited
ascending() → Ordering
Creates an ascending ordering for this expression
inherited
average() → PipelineAggregateFunction
Creates an average aggregation function from this expression
inherited
bitAnd(Expression bitsOther) → Expression
Performs bitwise AND with another expression
inherited
bitAndBytes(List<int> bitsOther) → Expression
Performs bitwise AND with byte array
inherited
bitLeftShift(Expression numberExpr) → Expression
Shifts bits left by an expression amount
inherited
bitLeftShiftLiteral(int number) → Expression
Shifts bits left by a literal amount
inherited
bitNot() → Expression
Performs bitwise NOT on this expression
inherited
bitOr(Expression bitsOther) → Expression
Performs bitwise OR with another expression
inherited
bitOrBytes(List<int> bitsOther) → Expression
Performs bitwise OR with byte array
inherited
bitRightShift(Expression numberExpr) → Expression
Shifts bits right by an expression amount
inherited
bitRightShiftLiteral(int number) → Expression
Shifts bits right by a literal amount
inherited
bitXor(Expression bitsOther) → Expression
Performs bitwise XOR with another expression
inherited
bitXorBytes(List<int> bitsOther) → Expression
Performs bitwise XOR with byte array
inherited
collectionId() → Expression
Returns the collection ID from this path expression
inherited
concat(List<Object?> others) → Expression
Concatenates this expression with other expressions/values
inherited
count() → PipelineAggregateFunction
Creates a count aggregation function from this expression
inherited
countDistinct() → PipelineAggregateFunction
Creates a count distinct aggregation function from this expression
inherited
descending() → Ordering
Creates a descending ordering for this expression
inherited
divide(Expression other) → Expression
Divides this expression by another expression
inherited
divideNumber(num other) → Expression
Divides this expression by a number
inherited
documentId() → Expression
Returns the document ID from this path expression
inherited
equal(Expression other) → BooleanExpression
Checks if this expression equals another expression
inherited
equalValue(Object? value) → BooleanExpression
Checks if this expression equals a value
inherited
exists() → BooleanExpression
Checks if this field expression exists in the document
inherited
first() → PipelineAggregateFunction
Aggregate: first value across inputs. See First.
inherited
greaterThan(Expression other) → BooleanExpression
Checks if this expression is greater than another expression
inherited
greaterThanOrEqual(Expression other) → BooleanExpression
Checks if this expression is greater than or equal to another expression
inherited
greaterThanOrEqualValue(Object? value) → BooleanExpression
Checks if this expression is greater than or equal to a value
inherited
greaterThanValue(Object? value) → BooleanExpression
Checks if this expression is greater than a value
inherited
ifAbsent(Expression elseExpr) → Expression
Returns an alternative expression if this expression is absent
inherited
ifAbsentValue(Object? elseValue) → Expression
Returns an alternative value if this expression is absent
inherited
ifError(Expression catchExpr) → Expression
Returns an alternative expression if this expression errors
inherited
ifErrorValue(Object? catchValue) → Expression
Returns an alternative value if this expression errors
inherited
ifNull(Expression replacement) → Expression
If this expression is null, evaluates to replacement.
inherited
ifNullValue(Object? replacement) → Expression
If this expression is null, evaluates to replacement.
inherited
isAbsent() → BooleanExpression
Checks if this expression is absent (null/undefined)
inherited
isError() → BooleanExpression
Checks if this expression produces an error
inherited
isType(Type valueType) → BooleanExpression
Whether this expression evaluates to the given backend Type.
inherited
join(Expression delimiter) → Expression
Joins array elements with a delimiter
inherited
joinLiteral(String delimiter) → Expression
Joins array elements with a literal delimiter
inherited
last() → PipelineAggregateFunction
Aggregate: last value across inputs. See Last.
inherited
length() → Expression
Returns the length of this string expression
inherited
lessThan(Expression other) → BooleanExpression
Checks if this expression is less than another expression
inherited
lessThanOrEqual(Expression other) → BooleanExpression
Checks if this expression is less than or equal to another expression
inherited
lessThanOrEqualValue(Object? value) → BooleanExpression
Checks if this expression is less than or equal to a value
inherited
lessThanValue(Object? value) → BooleanExpression
Checks if this expression is less than a value
inherited
ltrim([Object? valueToTrim]) → Expression
Trims leading whitespace, or the characters in valueToTrim when given.
inherited
mapEntries() → Expression
Returns an array of {k, v} map entries for this map expression.
inherited
mapGet(Expression key) → Expression
Gets a value from this map expression by key expression
inherited
mapGetLiteral(String key) → Expression
Gets a value from this map expression by literal key
inherited
mapKeys() → Expression
Returns an array of keys for this map expression.
inherited
mapSet(Object? key, Object? value, [List<Object?>? moreKeyValues]) → Expression
Returns a map expression with keys set to the given values (shallow update).
inherited
mapValues() → Expression
Returns an array of values for this map expression.
inherited
maximum() → PipelineAggregateFunction
Creates a maximum aggregation function from this expression
inherited
minimum() → PipelineAggregateFunction
Creates a minimum aggregation function from this expression
inherited
modulo(Expression other) → Expression
Returns the remainder of dividing this expression by another
inherited
moduloNumber(num other) → Expression
Returns the remainder of dividing this expression by a number
inherited
multiply(Expression other) → Expression
Multiplies this expression by another expression
inherited
multiplyNumber(num other) → Expression
Multiplies this expression by a number
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notEqual(Expression other) → BooleanExpression
Checks if this expression does not equal another expression
inherited
notEqualValue(Object? value) → BooleanExpression
Checks if this expression does not equal a value
inherited
parent() → Expression
Parent collection or document reference for this document reference expression.
inherited
regexFind(Object? pattern) → Expression
Returns the first regex match of pattern in this string expression.
inherited
regexFindAll(Object? pattern) → Expression
Returns all regex matches of pattern in this string expression.
inherited
rtrim([Object? valueToTrim]) → Expression
Trims trailing whitespace, or the characters in valueToTrim when given.
inherited
split(Expression delimiter) → Expression
Splits this string expression by a delimiter
inherited
splitLiteral(String delimiter) → Expression
Splits this string by a literal delimiter
inherited
stringIndexOf(Object? search) → Expression
Returns the index of search in this string, or an absent/error value if not found.
inherited
stringRepeat(Object? repetitions) → Expression
Repeats this string repetitions times (repetitions may be an Expression or number).
inherited
stringReplaceAll(Expression find, Expression replacement) → Expression
Replaces all occurrences of a pattern in this string (stringReplaceAll)
inherited
stringReplaceAllLiteral(String find, String replacement) → Expression
Replaces all occurrences of a string literal
inherited
stringReplaceOne(Expression find, Expression replacement) → Expression
Replaces the first occurrence of find with replacement.
inherited
stringReplaceOneLiteral(String find, String replacement) → Expression
Replaces the first occurrence of string literals find with replacement.
inherited
substring(Expression start, Expression end) → Expression
Extracts a substring from this string expression
inherited
substringLiteral(int start, int end) → Expression
Extracts a substring using literal indices
inherited
subtract(Expression other) → Expression
Subtracts another expression from this expression
inherited
subtractNumber(num other) → Expression
Subtracts a number from this expression
inherited
sum() → PipelineAggregateFunction
Creates a sum aggregation function from this expression
inherited
timestampDiff(Expression start, Object unit) → Expression
Difference between this timestamp (end) and start, in unit (a unit string or an expression).
inherited
timestampExtract(Object part, [Object? timezone]) → Expression
Extracts part (string or expression) from this timestamp; optional timezone.
inherited
toLowerCase() → Expression
Converts this string expression to lowercase
inherited
toMap() → Map<String, dynamic>
inherited
toString() → String
A string representation of this object.
inherited
toUpperCase() → Expression
Converts this string expression to uppercase
inherited
trim() → Expression
Trims whitespace from this string expression
inherited
trunc([Expression? decimals]) → Expression
Truncates this numeric expression toward zero.
inherited
type() → Expression
Returns the Firestore value type of this expression as a string (e.g. int64, timestamp). Possible values align with Type.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited