Windows

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object Bound

Special values that may be used when specifying the bounds of a window.
Special values that may be used when specifying the bounds of a window.

Annotations
@Beta()
Since
4.3
Note
Requires MongoDB 5.0 or greater.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
def documents(lower: Bound, upper: Bound): Window

Creates a documents window whose bounds are determined by a number of documents before and after the current document.
Creates a documents window whose bounds are determined by a number of documents before and after the current document.
lower
A value based on which the lower bound of the window is calculated.
upper
A value based on which the upper bound of the window is calculated.
returns
The constructed documents window.
def documents(lower: Int, upper: Bound): Window

Creates a documents window whose bounds are determined by a number of documents before and after the current document.
Creates a documents window whose bounds are determined by a number of documents before and after the current document.
lower
A value based on which the lower bound of the window is calculated.
upper
A value based on which the upper bound of the window is calculated.
returns
The constructed documents window.
def documents(lower: Bound, upper: Int): Window

Creates a documents window whose bounds are determined by a number of documents before and after the current document.
Creates a documents window whose bounds are determined by a number of documents before and after the current document.
lower
A value based on which the lower bound of the window is calculated.
upper
A value based on which the upper bound of the window is calculated.
returns
The constructed documents window.

Note
Requires MongoDB 5.0 or greater.
def documents(lower: Int, upper: Int): Window

Creates a documents window whose bounds are determined by a number of documents before and after the current document.
Creates a documents window whose bounds are determined by a number of documents before and after the current document.
lower
A value based on which the lower bound of the window is calculated.
upper
A value based on which the upper bound of the window is calculated.
returns
The constructed documents window.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def of(window: Bson): Window

Creates a window from Bson in situations when there is no builder method that better satisfies your needs.
Creates a window from Bson in situations when there is no builder method that better satisfies your needs. This method cannot be used to validate the syntax.
Example
The following code creates two functionally identical windows, though they may not be equal.
```
val pastWeek1: Window = Windows.timeRange(-1, MongoTimeUnit.WEEK, Windows.Bound.CURRENT)
val pastWeek2: Window = Windows.of(
    Document("range" -> BsonArray(-1, "current"),
        "unit" -> BsonString("week")))
```
window
A Bson representing the required window.
returns
The constructed window.
def range(lower: Decimal128, upper: Bound): Window

Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
lower
A value based on which the lower bound of the window is calculated.
upper
A value based on which the upper bound of the window is calculated.
returns
The constructed range window.
def range(lower: Double, upper: Bound): Window

Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
lower
A value based on which the lower bound of the window is calculated.
upper
A value based on which the upper bound of the window is calculated.
returns
The constructed range window.
def range(lower: Long, upper: Bound): Window

Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
lower
A value based on which the lower bound of the window is calculated.
upper
A value based on which the upper bound of the window is calculated.
returns
The constructed range window.
def range(lower: Bound, upper: Decimal128): Window

Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
lower
A value based on which the lower bound of the window is calculated.
upper
A value based on which the upper bound of the window is calculated.
returns
The constructed range window.
def range(lower: Bound, upper: Double): Window

Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
lower
A value based on which the lower bound of the window is calculated.
upper
A value based on which the upper bound of the window is calculated.
returns
The constructed range window.
def range(lower: Bound, upper: Long): Window

Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
lower
A value based on which the lower bound of the window is calculated.
upper
A value based on which the upper bound of the window is calculated.
returns
The constructed range window.
def range(lower: Decimal128, upper: Decimal128): Window

Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
lower
A value based on which the lower bound of the window is calculated.
upper
A value based on which the upper bound of the window is calculated.
returns
The constructed range window.
def range(lower: Double, upper: Double): Window

Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
lower
A value based on which the lower bound of the window is calculated.
upper
A value based on which the upper bound of the window is calculated.
returns
The constructed range window.
def range(lower: Long, upper: Long): Window

Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
lower
A value based on which the lower bound of the window is calculated.
upper
A value based on which the upper bound of the window is calculated.
returns
The constructed range window.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def timeRange(lower: Long, unit: MongoTimeUnit, upper: Bound): Window

Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the BSON Date value of the sortBy field in the current document.
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the BSON Date value of the sortBy field in the current document.
lower
A value based on which the lower bound of the window is calculated.
unit
A time unit in which lower is specified.
upper
A value based on which the upper bound of the window is calculated.
returns
The constructed range window.
def timeRange(lower: Bound, upper: Long, unit: MongoTimeUnit): Window

Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the BSON Date value of the sortBy field in the current document.
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the BSON Date value of the sortBy field in the current document.
lower
A value based on which the lower bound of the window is calculated.
upper
A value based on which the upper bound of the window is calculated.
unit
A time unit in which upper is specified.
returns
The constructed range window.
def timeRange(lower: Long, upper: Long, unit: MongoTimeUnit): Window

Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the BSON Date value of the sortBy field in the current document.
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the BSON Date value of the sortBy field in the current document.
lower
A value based on which the lower bound of the window is calculated.
upper
A value based on which the upper bound of the window is calculated.
unit
A time unit in which lower and upper are specified.
returns
The constructed range window.
def toString(): String

Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Doc: package model

object Windows

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Bound

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def documents(lower: Bound, upper: Bound): Window

def documents(lower: Int, upper: Bound): Window

def documents(lower: Bound, upper: Int): Window

def documents(lower: Int, upper: Int): Window

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def of(window: Bson): Window

def range(lower: Decimal128, upper: Bound): Window

def range(lower: Double, upper: Bound): Window

def range(lower: Long, upper: Bound): Window

def range(lower: Bound, upper: Decimal128): Window

def range(lower: Bound, upper: Double): Window

def range(lower: Bound, upper: Long): Window

def range(lower: Decimal128, upper: Decimal128): Window

def range(lower: Double, upper: Double): Window

def range(lower: Long, upper: Long): Window

final def synchronized[T0](arg0: ⇒ T0): T0

def timeRange(lower: Long, unit: MongoTimeUnit, upper: Bound): Window

def timeRange(lower: Bound, upper: Long, unit: MongoTimeUnit): Window

def timeRange(lower: Long, upper: Long, unit: MongoTimeUnit): Window

def toString(): String

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped