Class Passage


  • public final class Passage
    extends java.lang.Object
    Represents a passage (typically a sentence of the document).

    A passage contains getNumMatches() highlights from the query, and the offsets and query terms that correspond with each match.

    • Constructor Detail

      • Passage

        public Passage()
    • Method Detail

      • getStartOffset

        public int getStartOffset()
        Start offset of this passage.
        Returns:
        start index (inclusive) of the passage in the original content: always >= 0.
      • getEndOffset

        public int getEndOffset()
        End offset of this passage.
        Returns:
        end index (exclusive) of the passage in the original content: always >= getStartOffset()
      • getScore

        public float getScore()
        Passage's score.
      • getMatchStarts

        public int[] getMatchStarts()
        Start offsets of the term matches, in increasing order.

        Only getNumMatches() are valid. Note that these offsets are absolute (not relative to getStartOffset()).

      • getMatchEnds

        public int[] getMatchEnds()
        End offsets of the term matches, corresponding with getMatchStarts().

        Only getNumMatches() are valid. Note that its possible that an end offset could exceed beyond the bounds of the passage (getEndOffset()), if the Analyzer produced a term which spans a passage boundary.