Package com.couchbase.client.java.search.result

Class SearchRowLocation

java.lang.Object
com.couchbase.client.java.search.result.SearchRowLocation
@Volatile public class SearchRowLocation extends Object
A FTS result row location indicates at which position a given term occurs inside a given field. In case the field is an array, arrayPositions() will indicate which index/indices in the array contain the term.
Since:
2.3.0
Author:
Simon Baslé, Michael Nitschinger

  • Method Details

    • field

      public String field()

    • term

      public String term()

    • pos

      public long pos()
      Returns:
      the position of the term within the field, starting at 1

    • start

      public long start()
      Returns:
      the start offset (in bytes) of the term in the field

    • end

      public long end()
      Returns:
      the end offset (in bytes) of the term in the field

    • arrayPositions

      @Nullable public long[] arrayPositions()
      Contains the positions of the term within any elements.
      Returns:
      the array positions, or null if not applicable.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object