Packages

case class SearchRow(index: String, id: String, score: Double, _explanation: Try[Array[Byte]], locations: Option[SearchRowLocations], fragments: Map[String, Seq[String]], fields: Try[Array[Byte]]) extends Product with Serializable

An FTS row (or "hit")

index

The name of the FTS pindex that gave this result.

id

The id of the matching document.

score

The score of this hit.

locations

This rows's location, as a SearchRowLocations.

fragments

The fragments for each field that was requested as highlighted. A fragment is an extract of the field's value where the matching terms occur. Matching terms are surrounded by a <match> tag.

fields

The value of each requested field, as a map. The key is the field.

Since

1.0.0

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SearchRow
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SearchRow(index: String, id: String, score: Double, _explanation: Try[Array[Byte]], locations: Option[SearchRowLocations], fragments: Map[String, Seq[String]], fields: Try[Array[Byte]])

    index

    The name of the FTS pindex that gave this result.

    id

    The id of the matching document.

    score

    The score of this hit.

    locations

    This rows's location, as a SearchRowLocations.

    fragments

    The fragments for each field that was requested as highlighted. A fragment is an extract of the field's value where the matching terms occur. Matching terms are surrounded by a <match> tag.

    fields

    The value of each requested field, as a map. The key is the field.

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( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def explanationAs[T](implicit deserializer: JsonDeserializer[T]): Try[T]

    If explain was set on the SearchQuery this will return an explanation of the match.

    If explain was set on the SearchQuery this will return an explanation of the match.

    It can be returned in any supported JSON type, e.g. com.couchbase.client.scala.json.JsonObject. See a full list at these JSON docs

  8. def fieldsAs[T](implicit deserializer: JsonDeserializer[T]): Try[T]
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. val fragments: Map[String, Seq[String]]
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. val id: String
  13. val index: String
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. val locations: Option[SearchRowLocations]
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. val score: Double
  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped