Package ch.rswk.meta.engine

Record Class LuceneService.SearchResultCursor

java.lang.Object
java.lang.Record
ch.rswk.meta.engine.LuceneService.SearchResultCursor
Enclosing class:
LuceneService
public static record LuceneService.SearchResultCursor(int doc, @Nullable Set<?> fields, float score, int shardIndex) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final int
    doc
    The field for the doc record component.
    private final @Nullable Set<?>
    fields
    The field for the fields record component.
    private final float
    score
    The field for the score record component.
    private final int
    shardIndex
    The field for the shardIndex record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SearchResultCursor(int doc, @Nullable Set<?> fields, float score, int shardIndex)
    Creates an instance of a SearchResultCursor record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    doc()
    Returns the value of the doc record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    @Nullable Set<?>
    fields()
    Returns the value of the fields record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    float
    score()
    Returns the value of the score record component.
    int
    shardIndex()
    Returns the value of the shardIndex record component.
    @Nullable org.apache.lucene.search.ScoreDoc
    toScoreDoc()
     
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • doc

      private final int doc
      The field for the doc record component.

    • fields

      private final @Nullable Set<?> fields
      The field for the fields record component.

    • score

      private final float score
      The field for the score record component.

    • shardIndex

      private final int shardIndex
      The field for the shardIndex record component.

  • Constructor Details

    • SearchResultCursor

      public SearchResultCursor(int doc, @Nullable Set<?> fields, float score, int shardIndex)
      Creates an instance of a SearchResultCursor record class.
      Parameters:
      doc - the value for the doc record component
      fields - the value for the fields record component
      score - the value for the score record component
      shardIndex - the value for the shardIndex record component

  • Method Details

    • toScoreDoc

      public @Nullable org.apache.lucene.search.ScoreDoc toScoreDoc()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • doc

      public int doc()
      Returns the value of the doc record component.
      Returns:
      the value of the doc record component

    • fields

      public @Nullable Set<?> fields()
      Returns the value of the fields record component.
      Returns:
      the value of the fields record component

    • score

      public float score()
      Returns the value of the score record component.
      Returns:
      the value of the score record component

    • shardIndex

      public int shardIndex()
      Returns the value of the shardIndex record component.
      Returns:
      the value of the shardIndex record component