object Filter extends AsJava
- Alphabetic
- By Inheritance
- Filter
- AsJava
- AsJavaConverters
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
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
- def all[A](fieldName: String, values: Seq[A]): Filter
Creates a filter that matches all documents where the value of a field is an array that contains all the specified values.
Creates a filter that matches all documents where the value of a field is an array that contains all the specified values.
- fieldName
the field name
- values
the list of values
- returns
the filter
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asJava[K, V](m: Map[K, V]): ConcurrentMap[K, V]
- Definition Classes
- AsJavaConverters
- def asJava[K, V](m: Map[K, V]): Map[K, V]
- Definition Classes
- AsJavaConverters
- def asJava[K, V](m: Map[K, V]): Map[K, V]
- Definition Classes
- AsJavaConverters
- def asJava[A](s: Set[A]): Set[A]
- Definition Classes
- AsJavaConverters
- def asJava[A](s: Set[A]): Set[A]
- Definition Classes
- AsJavaConverters
- def asJava[A](s: Seq[A]): List[A]
- Definition Classes
- AsJavaConverters
- def asJava[A](s: Seq[A]): List[A]
- Definition Classes
- AsJavaConverters
- def asJava[A](b: Buffer[A]): List[A]
- Definition Classes
- AsJavaConverters
- def asJava[A](i: Iterable[A]): Iterable[A]
- Definition Classes
- AsJavaConverters
- def asJava[A](i: Iterator[A]): Iterator[A]
- Definition Classes
- AsJavaConverters
- def asJavaCollection[A](i: Iterable[A]): Collection[A]
- Definition Classes
- AsJavaConverters
- def asJavaDictionary[K, V](m: Map[K, V]): Dictionary[K, V]
- Definition Classes
- AsJavaConverters
- def asJavaEnumeration[A](i: Iterator[A]): Enumeration[A]
- Definition Classes
- AsJavaConverters
- def bitsAllClear(fieldName: String, bitmask: Long): Filter
Creates a filter that matches all documents where all of the bit positions are clear in the field.
Creates a filter that matches all documents where all of the bit positions are clear in the field.
- fieldName
the field name
- bitmask
the bitmask
- returns
the filter
- Since
3.2
- def bitsAllSet(fieldName: String, bitmask: Long): Filter
Creates a filter that matches all documents where all of the bit positions are set in the field.
Creates a filter that matches all documents where all of the bit positions are set in the field.
- fieldName
the field name
- bitmask
the bitmask
- returns
the filter
- Since
3.2
- def bitsAnyClear(fieldName: String, bitmask: Long): Filter
Creates a filter that matches all documents where any of the bit positions are clear in the field.
Creates a filter that matches all documents where any of the bit positions are clear in the field.
- fieldName
the field name
- bitmask
the bitmask
- returns
the filter
- Since
3.2
- def bitsAnySet(fieldName: String, bitmask: Long): Filter
Creates a filter that matches all documents where any of the bit positions are set in the field.
Creates a filter that matches all documents where any of the bit positions are set in the field.
- fieldName
the field name
- bitmask
the bitmask
- returns
the filter
- Since
3.2
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def elemMatch(fieldName: String, filter: Filter): Filter
Creates a filter that matches all documents containing a field that is an array where at least one member of the array matches the given filter.
Creates a filter that matches all documents containing a field that is an array where at least one member of the array matches the given filter.
- fieldName
the field name
- filter
the filter to apply to each element
- returns
the filter
- val empty: Filter
A filter that matches all documents.
A filter that matches all documents.
- returns
the filter
- Since
3.4
- def eq[A](fieldName: String, value: A): Filter
Creates a filter that matches all documents where the value of the field name equals the specified value.
Creates a filter that matches all documents where the value of the field name equals the specified value. Note that this doesn't actually generate a $eq operator, as the query language doesn't require it.
- fieldName
the field name
- value
the value, which may be null
- returns
the filter
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def exists(fieldName: String): Filter
Creates a filter that matches all documents that contain the given field.
Creates a filter that matches all documents that contain the given field.
- fieldName
the field name
- returns
the filter
- def geoIntersects(fieldName: String, geometry: Bson): Filter
Creates a filter that matches all documents containing a field with geospatial data that intersects with the specified shape.
Creates a filter that matches all documents containing a field with geospatial data that intersects with the specified shape.
- fieldName
the field name
- geometry
the bounding GeoJSON geometry object
- returns
the filter
- Since
3.1
- def geoIntersects(fieldName: String, geometry: Geometry): Filter
Creates a filter that matches all documents containing a field with geospatial data that intersects with the specified shape.
Creates a filter that matches all documents containing a field with geospatial data that intersects with the specified shape.
- fieldName
the field name
- geometry
the bounding GeoJSON geometry object
- returns
the filter
- Since
3.1
- def geoWithin(fieldName: String, geometry: Bson): Filter
Creates a filter that matches all documents containing a field with geospatial data that exists entirely within the specified shape.
Creates a filter that matches all documents containing a field with geospatial data that exists entirely within the specified shape.
- fieldName
the field name
- geometry
the bounding GeoJSON geometry object
- returns
the filter
- Since
3.1
- def geoWithin(fieldName: String, geometry: Geometry): Filter
Creates a filter that matches all documents containing a field with geospatial data that exists entirely within the specified shape.
Creates a filter that matches all documents containing a field with geospatial data that exists entirely within the specified shape.
- fieldName
the field name
- geometry
the bounding GeoJSON geometry object
- returns
the filter
- Since
3.1
- def geoWithinBox(fieldName: String, lowerLeftX: Double, lowerLeftY: Double, upperRightX: Double, upperRightY: Double): Filter
Creates a filter that matches all documents containing a field with grid coordinates data that exist entirely within the specified box.
Creates a filter that matches all documents containing a field with grid coordinates data that exist entirely within the specified box.
- fieldName
the field name
- lowerLeftX
the lower left x coordinate of the box
- lowerLeftY
the lower left y coordinate of the box
- upperRightX
the upper left x coordinate of the box
- upperRightY
the upper left y coordinate of the box
- returns
the filter
- Since
3.1
- def geoWithinCenter(fieldName: String, x: Double, y: Double, radius: Double): Filter
Creates a filter that matches all documents containing a field with grid coordinates data that exist entirely within the specified circle.
Creates a filter that matches all documents containing a field with grid coordinates data that exist entirely within the specified circle.
- fieldName
the field name
- x
the x coordinate of the circle
- y
the y coordinate of the circle
- radius
the radius of the circle, as measured in the units used by the coordinate system
- returns
the filter
- Since
3.1
- def geoWithinCenterSphere(fieldName: String, x: Double, y: Double, radius: Double): Filter
Creates a filter that matches all documents containing a field with geospatial data (GeoJSON or legacy coordinate pairs) that exist entirely within the specified circle, using spherical geometry.
Creates a filter that matches all documents containing a field with geospatial data (GeoJSON or legacy coordinate pairs) that exist entirely within the specified circle, using spherical geometry. If using longitude and latitude, specify longitude first.
- fieldName
the field name
- x
the x coordinate of the circle
- y
the y coordinate of the circle
- radius
the radius of the circle, in radians
- returns
the filter
- Since
3.1
- def geoWithinPolygon(fieldName: String, points: Seq[Seq[Double]]): Filter
Creates a filter that matches all documents containing a field with grid coordinates data that exist entirely within the specified polygon.
Creates a filter that matches all documents containing a field with grid coordinates data that exist entirely within the specified polygon.
- fieldName
the field name
- points
a list of pairs of x, y coordinates. Any extra dimensions are ignored
- returns
the filter
- Since
3.1
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def gt[A](fieldName: String, value: A): Filter
Creates a filter that matches all documents where the value of the given field is greater than the specified value.
Creates a filter that matches all documents where the value of the given field is greater than the specified value.
- fieldName
the field name
- value
the value
- returns
the filter
- def gte[A](fieldName: String, value: A): Filter
Creates a filter that matches all documents where the value of the given field is greater than or equal to the specified value.
Creates a filter that matches all documents where the value of the given field is greater than or equal to the specified value.
- fieldName
the field name
- value
the value
- returns
the filter
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def idEq[A](value: A): Filter
Creates a filter that matches all documents where the value of _id field equals the specified value.
Creates a filter that matches all documents where the value of _id field equals the specified value. Note that this doesn't actually generate a $eq operator, as the query language doesn't require it.
- value
the value, which may be null
- returns
the filter
- Since
3.4
- def in[A](fieldName: String, values: Seq[A]): Filter
Creates a filter that matches all documents where the value of a field equals any value in the list of specified values.
Creates a filter that matches all documents where the value of a field equals any value in the list of specified values.
- fieldName
the field name
- values
the list of values
- returns
the filter
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isNull(fieldName: String): Filter
Creates a filter that matches all documents where the value of the provided field is null.
Creates a filter that matches all documents where the value of the provided field is null.
- fieldName
the field name
- returns
the filter
- def jsonSchema(schema: Bson): Filter
Creates a filter that matches all documents that validate against the given JSON schema document.
Creates a filter that matches all documents that validate against the given JSON schema document.
- schema
the JSON schema to validate against
- returns
the filter
- Since
3.6
- def lt[A](fieldName: String, value: A): Filter
Creates a filter that matches all documents where the value of the given field is less than the specified value.
Creates a filter that matches all documents where the value of the given field is less than the specified value.
- fieldName
the field name
- value
the value
- returns
the filter
- def lte[A](fieldName: String, value: A): Filter
Creates a filter that matches all documents where the value of the given field is less than or equal to the specified value.
Creates a filter that matches all documents where the value of the given field is less than or equal to the specified value.
- fieldName
the field name
- value
the value
- returns
the filter
- def mod(fieldName: String, divisor: Long, remainder: Long): Filter
Creates a filter that matches all documents where the value of a field divided by a divisor has the specified remainder (i.e.
Creates a filter that matches all documents where the value of a field divided by a divisor has the specified remainder (i.e. perform a modulo operation to select documents).
- fieldName
the field name
- divisor
the modulus
- remainder
the remainder
- returns
the filter
- def ne[A](fieldName: String, value: A): Filter
Creates a filter that matches all documents where the value of the field name does not equal the specified value.
Creates a filter that matches all documents where the value of the field name does not equal the specified value.
- fieldName
the field name
- value
the value, which may be null
- returns
the filter
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def near(fieldName: String, x: Double, y: Double, maxDistance: Double, minDistance: Double): Filter
Creates a filter that matches all documents containing a field with geospatial data that is near the specified point.
Creates a filter that matches all documents containing a field with geospatial data that is near the specified point.
- fieldName
the field name
- x
the x coordinate
- y
the y coordinate
- maxDistance
the maximum distance from the point, in radians. It may be null.
- minDistance
the minimum distance from the point, in radians. It may be null.
- returns
the filter
- Since
3.1
- def near(fieldName: String, geometry: Bson, maxDistance: Double, minDistance: Double): Filter
Creates a filter that matches all documents containing a field with geospatial data that is near the specified GeoJSON point.
Creates a filter that matches all documents containing a field with geospatial data that is near the specified GeoJSON point.
- fieldName
the field name
- geometry
the bounding GeoJSON geometry object
- maxDistance
the maximum distance from the point, in meters. It may be null.
- minDistance
the minimum distance from the point, in meters. It may be null.
- returns
the filter
- Since
3.1
- def near(fieldName: String, geometry: Point, maxDistance: Double, minDistance: Double): Filter
Creates a filter that matches all documents containing a field with geospatial data that is near the specified GeoJSON point.
Creates a filter that matches all documents containing a field with geospatial data that is near the specified GeoJSON point.
- fieldName
the field name
- geometry
the bounding GeoJSON geometry object
- maxDistance
the maximum distance from the point, in meters. It may be null.
- minDistance
the minimum distance from the point, in meters. It may be null.
- returns
the filter
- Since
3.1
- def nearSphere(fieldName: String, x: Double, y: Double, maxDistance: Double, minDistance: Double): Filter
Creates a filter that matches all documents containing a field with geospatial data that is near the specified point using spherical geometry.
Creates a filter that matches all documents containing a field with geospatial data that is near the specified point using spherical geometry.
- fieldName
the field name
- x
the x coordinate
- y
the y coordinate
- maxDistance
the maximum distance from the point, in radians. It may be null.
- minDistance
the minimum distance from the point, in radians. It may be null.
- returns
the filter
- Since
3.1
- def nearSphere(fieldName: String, geometry: Bson, maxDistance: Double, minDistance: Double): Filter
Creates a filter that matches all documents containing a field with geospatial data that is near the specified GeoJSON point using spherical geometry.
Creates a filter that matches all documents containing a field with geospatial data that is near the specified GeoJSON point using spherical geometry.
- fieldName
the field name
- geometry
the bounding GeoJSON geometry object
- maxDistance
the maximum distance from the point, in meters. It may be null.
- minDistance
the minimum distance from the point, in meters. It may be null.
- returns
the filter
- Since
3.1
- def nearSphere(fieldName: String, geometry: Point, maxDistance: Double, minDistance: Double): Filter
Creates a filter that matches all documents containing a field with geospatial data that is near the specified GeoJSON point using spherical geometry.
Creates a filter that matches all documents containing a field with geospatial data that is near the specified GeoJSON point using spherical geometry.
- fieldName
the field name
- geometry
the bounding GeoJSON geometry object
- maxDistance
the maximum distance from the point, in meters. It may be null.
- minDistance
the minimum distance from the point, in meters. It may be null.
- returns
the filter
- Since
3.1
- def nin[A](fieldName: String, values: Seq[A]): Filter
Creates a filter that matches all documents where the value of a field does not equal any of the specified values or does not exist.
Creates a filter that matches all documents where the value of a field does not equal any of the specified values or does not exist.
- fieldName
the field name
- values
the list of values
- returns
the filter
- def notExists(fieldName: String): Filter
Creates a filter that matches all documents that do not contain the given field.
Creates a filter that matches all documents that do not contain the given field.
- fieldName
the field name
- returns
the filter
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def regex(fieldName: String, regex: Regex): Filter
Creates a filter that matches all documents where the value of the field matches the given regular expression pattern.
Creates a filter that matches all documents where the value of the field matches the given regular expression pattern.
- fieldName
the field name
- regex
the pattern
- returns
the filter
- def regex(fieldName: String, pattern: String): Filter
Creates a filter that matches all documents where the value of the field matches the given regular expression pattern.
Creates a filter that matches all documents where the value of the field matches the given regular expression pattern.
- fieldName
the field name
- pattern
the pattern
- returns
the filter
- def size(fieldName: String, size: Int): Filter
Creates a filter that matches all documents where the value of a field is an array of the specified size.
Creates a filter that matches all documents where the value of a field is an array of the specified size.
- fieldName
the field name
- size
the size of the array
- returns
the filter
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def text(search: String, textSearchOptions: TextSearchOptions): Filter
Creates a filter that matches all documents matching the given search term.
Creates a filter that matches all documents matching the given search term.
- search
the search term
- textSearchOptions
the text search options to use
- returns
the filter
- def text(search: String): Filter
Creates a filter that matches all documents matching the given search term.
Creates a filter that matches all documents matching the given search term.
- search
the search term
- returns
the filter
- def toString(): String
- Definition Classes
- AnyRef → Any
- def typeIs(fieldName: String, fieldType: String): Filter
Creates a filter that matches all documents where the value of the field is of the specified BSON type.
Creates a filter that matches all documents where the value of the field is of the specified BSON type.
- fieldName
the field name
- fieldType
the string representation of the BSON type
- returns
the filter
- def typeIs(fieldName: String, fieldType: BsonType): Filter
Creates a filter that matches all documents where the value of the field is of the specified BSON type.
Creates a filter that matches all documents where the value of the field is of the specified BSON type.
- fieldName
the field name
- fieldType
the BSON type
- returns
the filter
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def where(javaScriptExpression: String): Filter
Creates a filter that matches all documents for which the given expression is true.
Creates a filter that matches all documents for which the given expression is true.
- javaScriptExpression
the JavaScript expression
- returns
the filter
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)