reactivemongo.api.commands.AggregationFramework

GeoNear

case class GeoNear(near: P.Value, spherical: Boolean = false, limit: Long = 100, minDistance: Option[Long] = scala.None, maxDistance: Option[Long] = scala.None, query: Option[P.Document] = scala.None, distanceMultiplier: Option[Double] = scala.None, uniqueDocs: Boolean = false, distanceField: Option[String] = scala.None, includeLocs: Option[String] = scala.None) extends PipelineOperator with Product with Serializable

Outputs documents in order of nearest to farthest from a specified point.

http://docs.mongodb.org/manual/reference/operator/aggregation/geoNear/#pipe._S_geoNear

near

the point for which to find the closest documents

spherical

if using a 2dsphere index

limit

the maximum number of documents to return

maxDistance

the maximum distance from the center point that the documents can be

query

limits the results to the matching documents

distanceMultiplier

the factor to multiply all distances returned by the query

uniqueDocs

if this value is true, the query returns a matching document once

distanceField

the output field that contains the calculated distance

includeLocs

this specifies the output field that identifies the location used to calculate the distance

Linear Supertypes
Serializable, Serializable, Product, Equals, PipelineOperator, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. GeoNear
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. PipelineOperator
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GeoNear(near: P.Value, spherical: Boolean = false, limit: Long = 100, minDistance: Option[Long] = scala.None, maxDistance: Option[Long] = scala.None, query: Option[P.Document] = scala.None, distanceMultiplier: Option[Double] = scala.None, uniqueDocs: Boolean = false, distanceField: Option[String] = scala.None, includeLocs: Option[String] = scala.None)

    near

    the point for which to find the closest documents

    spherical

    if using a 2dsphere index

    limit

    the maximum number of documents to return

    maxDistance

    the maximum distance from the center point that the documents can be

    query

    limits the results to the matching documents

    distanceMultiplier

    the factor to multiply all distances returned by the query

    uniqueDocs

    if this value is true, the query returns a matching document once

    distanceField

    the output field that contains the calculated distance

    includeLocs

    this specifies the output field that identifies the location used to calculate the distance

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from GeoNear to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (GeoNear, B)

    Implicit information
    This member is added by an implicit conversion from GeoNear to ArrowAssoc[GeoNear] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. val distanceField: Option[String]

    the output field that contains the calculated distance

  11. val distanceMultiplier: Option[Double]

    the factor to multiply all distances returned by the query

  12. def ensuring(cond: (GeoNear) ⇒ Boolean, msg: ⇒ Any): GeoNear

    Implicit information
    This member is added by an implicit conversion from GeoNear to Ensuring[GeoNear] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: (GeoNear) ⇒ Boolean): GeoNear

    Implicit information
    This member is added by an implicit conversion from GeoNear to Ensuring[GeoNear] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: Boolean, msg: ⇒ Any): GeoNear

    Implicit information
    This member is added by an implicit conversion from GeoNear to Ensuring[GeoNear] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  15. def ensuring(cond: Boolean): GeoNear

    Implicit information
    This member is added by an implicit conversion from GeoNear to Ensuring[GeoNear] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  17. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  18. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from GeoNear to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  20. val includeLocs: Option[String]

    this specifies the output field that identifies the location used to calculate the distance

  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  22. val limit: Long

    the maximum number of documents to return

  23. def makePipe: P.Document

    Definition Classes
    GeoNear → PipelineOperator

  24. val maxDistance: Option[Long]

    the maximum distance from the center point that the documents can be

  25. val minDistance: Option[Long]

  26. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  27. val near: P.Value

    the point for which to find the closest documents

  28. final def notify(): Unit

    Definition Classes
    AnyRef

  29. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  30. val query: Option[P.Document]

    limits the results to the matching documents

  31. val spherical: Boolean

    if using a 2dsphere index

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

    Definition Classes
    AnyRef

  33. val uniqueDocs: Boolean

    if this value is true, the query returns a matching document once

  34. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  36. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  37. def →[B](y: B): (GeoNear, B)

    Implicit information
    This member is added by an implicit conversion from GeoNear to ArrowAssoc[GeoNear] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from GeoNear to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (geoNear: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from GeoNear to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (geoNear: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: GeoNear

    Implicit information
    This member is added by an implicit conversion from GeoNear to ArrowAssoc[GeoNear] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (geoNear: ArrowAssoc[GeoNear]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: GeoNear

    Implicit information
    This member is added by an implicit conversion from GeoNear to Ensuring[GeoNear] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (geoNear: Ensuring[GeoNear]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from PipelineOperator

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from GeoNear to StringAdd

Inherited by implicit conversion any2stringfmt from GeoNear to StringFormat

Inherited by implicit conversion any2ArrowAssoc from GeoNear to ArrowAssoc[GeoNear]

Inherited by implicit conversion any2Ensuring from GeoNear to Ensuring[GeoNear]

Ungrouped