Package com.pspdfkit.document.library

Class QueryPreviewResult

  • All Implemented Interfaces:
    
public class QueryPreviewResult

    Result from a FTS search which includes preview entries.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      String getUid() Returns UID of the document this preview result belongs to.
      int getPageIndex() Returns page index of the page this preview result belongs to.
      Range getRange() Returns the range of this result in the document text.
      String getPreviewText() Returns the preview text of the found text result.
      Range getRangeInPreviewText() Returns the range of the result in the preview text.
      int hashCode()
      boolean equals(Object o)
      String toString()

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • getUid

        @NonNull() String getUid()

        Returns UID of the document this preview result belongs to.

        Returns:

        UID of the owner document.

      • getPageIndex

         int getPageIndex()

        Returns page index of the page this preview result belongs to.

        Returns:

        Document page index of the result, 0-indexed.

      • getRange

        @NonNull() Range getRange()

        Returns the range of this result in the document text.

        Returns:

        Range of the result in the document text. First number is the first character index of the result and the second number is the last character index of the result.

      • getPreviewText

        @NonNull() String getPreviewText()

        Returns the preview text of the found text result.

        Returns:

        Returns short preview excerpt of the found text.

      • getRangeInPreviewText

        @NonNull() Range getRangeInPreviewText()

        Returns the range of the result in the preview text.

        Returns:

        Range of the result in the preview text retrieved with getPreviewText. First number is the first character index of the result and the second number is the last character index of the result.