Packages

object SearchSort

Base class for all FTS sort options in querying.

Since

1.0.0

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SearchSort
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. case class FieldSort(field: String, typ: Option[FieldSortType] = None, mode: Option[FieldSortMode] = None, missing: Option[FieldSortMissing] = None, descending: Option[Boolean] = None) extends SearchSort with Product with Serializable

    Sort by a field in the rows.

    Sort by a field in the rows.

    field

    the name of the field to sort on

    typ

    the type of the field. If left at the default None, it will default on the server to Auto

    mode

    the sort mode. If left at the default None, it will default on the server to Default

    missing

    the missing mode. If left at the default None, it will default on the server to Last

    descending

    whether the search results should be sorted in descending order. If None (the default) is specified, it is left to the server (which sorts descending by default)

  2. case class GeoDistanceSort(location: Seq[Float], field: String, descending: Option[Boolean] = None, unit: Option[String] = None) extends SearchSort with Product with Serializable

    Sort by a geo location distance.

    Sort by a geo location distance.

    location

    should be a two-value Seq containing the longitude and latitude (in that order) to centre the search on

    field

    the name of the field to sort on

    descending

    whether the search results should be sorted in descending order. If None (the default) is specified, it is left to the server (which sorts descending by default)

    unit

    the unit multipler to use for sorting. Acceptable values are: "inch", "yards", "feet", "kilometers", "nauticalmiles", "millimeters", "centimeters", "miles" and "meters". Standard abbreviations for those ("ft", "km", "mi") may also be used. If left at default None, it defaults on the server side to "meters".

    Since

    1.0.0

  3. case class IdSort(descending: Option[Boolean] = None) extends SearchSort with Product with Serializable

    Sort by the document ID.

    Sort by the document ID.

    descending

    whether the search results should be sorted in descending order. If None (the default) is specified, it is left to the server (which sorts descending by default)

    Since

    1.0.0

  4. case class ScoreSort(descending: Option[Boolean] = None) extends SearchSort with Product with Serializable

    Sort by the hit score.

    Sort by the hit score.

    descending

    whether the search results should be sorted in descending order. If None (the default) is specified, it is left to the server (which sorts descending by default)

    Since

    1.0.0

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped