Output class

Creates an "output" document for the setWinowsDield stage

• fieldName -Specifies the field to append to the documents in the output returned by the $setWindowFields stage. Each field is set to the result returned by the window operator. A field can contain dots to specify embedded document fields and array fields. The semantics for the embedded document dotted notation in the $setWindowFields stage are the same as the $addFields and $set stages. See embedded document $addFields example and embedded document $set example.

  • operator - The window operator is the window operator to use in the $setWindowFields stage.

  The window operator parameters are the parameters to pass to the window operator. Specifies the window boundaries and parameters. Window boundaries are inclusive. Default is an unbounded window, which includes all documents in the partition. Specify either a documents or range window.

  • documents Optional - A window where the lower and upper boundaries are specified relative to the position of the current document read from the collection. The window boundaries are specified using a two element array containing a lower and upper limit string or integer. Use:
    • The "current" string for the current document position in the output
    • The "unbounded" string for the first or last document position in the partition.
  • range Optional - A window where the lower and upper boundaries are defined using a range of values based on the sortBy field in the current document. The window boundaries are specified using a two element array containing a lower and upper limit string or number. Use:
    • The "current" string for the current document position in the output
    • The "unbounded" string for the first or last document position in the partition.
    • A number to add to the value of the sortBy field for the current document. A document is in the window if the sortBy field value is inclusively within the lower and upper boundaries.

• unit Optional -Specifies the units for time range window boundaries. Can be set to one of these strings:

  • "year"
  • "quarter"
  • "month"
  • "week"
  • "day"
  • "hour"
  • "minute"
  • "second"
  • "millisecond"

  If omitted, default numeric range window boundaries are used.

Inheritance

• Object
• Iterable<MapEntry<String, dynamic>>
• AEObject
• Output

Constructors

Output(String fieldName, Accumulator operator, {List? documents, List? range, String? unit})

Properties

first → MapEntry<String, dynamic>

The first element.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

isEmpty → bool

Whether this collection has no elements.

no setter, inherited

isNotEmpty → bool

Whether this collection has at least one element.

no setter, inherited

iterator → AEIterator<MapEntry<String, dynamic>>

A new Iterator that allows iterating the elements of this Iterable.

no setter, inherited

last → MapEntry<String, dynamic>

The last element.

no setter, inherited

length → int

The number of elements in this Iterable.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

single → MapEntry<String, dynamic>

Checks that this iterable has only one element, and returns that element.

no setter, inherited

Methods

any(bool test(MapEntry<String, dynamic> element)) → bool

Checks whether any element of this iterable satisfies test.

inherited

build() → Map<String, dynamic>

inherited

cast<R>() → Iterable<R>

A view of this iterable as an iterable of R instances.

inherited

contains(Object? element) → bool

Whether the collection contains an element equal to element.

inherited

elementAt(int index) → MapEntry<String, dynamic>

Returns the indexth element.

inherited

every(bool test(MapEntry<String, dynamic> element)) → bool

Checks whether every element of this iterable satisfies test.

inherited

expand<T>(Iterable<T> toElements(MapEntry<String, dynamic> element)) → Iterable<T>

Expands each element of this Iterable into zero or more elements.

inherited

firstWhere(bool test(MapEntry<String, dynamic> element), {MapEntry<String, dynamic> orElse()?}) → MapEntry<String, dynamic>

The first element that satisfies the given predicate test.

inherited

fold<T>(T initialValue, T combine(T previousValue, MapEntry<String, dynamic> element)) → T

Reduces a collection to a single value by iteratively combining each element of the collection with an existing value

inherited

followedBy(Iterable<MapEntry<String, dynamic>> other) → Iterable<MapEntry<String, dynamic>>

Creates the lazy concatenation of this iterable and other.

inherited

forEach(void action(MapEntry<String, dynamic> element)) → void

Invokes action on each element of this iterable in iteration order.

inherited

join([String separator = ""]) → String

Converts each element to a String and concatenates the strings.

inherited

lastWhere(bool test(MapEntry<String, dynamic> element), {MapEntry<String, dynamic> orElse()?}) → MapEntry<String, dynamic>

The last element that satisfies the given predicate test.

inherited

map<T>(T toElement(MapEntry<String, dynamic> e)) → Iterable<T>

The current elements of this iterable modified by toElement.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

reduce(MapEntry<String, dynamic> combine(MapEntry<String, dynamic> value, MapEntry<String, dynamic> element)) → MapEntry<String, dynamic>

Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.

inherited

singleWhere(bool test(MapEntry<String, dynamic> element), {MapEntry<String, dynamic> orElse()?}) → MapEntry<String, dynamic>

The single element that satisfies test.

inherited

skip(int count) → Iterable<MapEntry<String, dynamic>>

Creates an Iterable that provides all but the first count elements.

inherited

skipWhile(bool test(MapEntry<String, dynamic> value)) → Iterable<MapEntry<String, dynamic>>

Creates an Iterable that skips leading elements while test is satisfied.

inherited

take(int count) → Iterable<MapEntry<String, dynamic>>

Creates a lazy iterable of the count first elements of this iterable.

inherited

takeWhile(bool test(MapEntry<String, dynamic> value)) → Iterable<MapEntry<String, dynamic>>

Creates a lazy iterable of the leading elements satisfying test.

inherited

toList({bool growable = true}) → List<MapEntry<String, dynamic>>

Creates a List containing the elements of this Iterable.

inherited

toSet() → Set<MapEntry<String, dynamic>>

Creates a Set containing the same elements as this iterable.

inherited

toString() → String

Returns a string representation of (some of) the elements of this.

inherited

where(bool test(MapEntry<String, dynamic> element)) → Iterable<MapEntry<String, dynamic>>

Creates a new lazy Iterable with all elements that satisfy the predicate test.

inherited

whereType<T>() → Iterable<T>

Creates a new lazy Iterable with all elements that have type T.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited