| java.lang.Object | |
| ↳ | com.pspdfkit.document.library.QueryPreviewResult |
Class Overview
Result from a FTS search which includes preview entries.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean | equals(Object o) | ||||||||||
| int |
getPageIndex()
Returns page index of the page this preview result belongs to.
| ||||||||||
| String |
getPreviewText()
Returns the preview text of the found text result.
| ||||||||||
| Range |
getRange()
Returns the range of this result in the document text.
| ||||||||||
| Range |
getRangeInPreviewText()
Returns the range of the result in the preview text.
| ||||||||||
| String |
getUid()
Returns UID of the document this preview result belongs to.
| ||||||||||
| int | hashCode() | ||||||||||
| String | toString() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Methods
public int getPageIndex ()
Returns page index of the page this preview result belongs to.
Returns
- Document page index of the result, 0-indexed.
public String getPreviewText ()
Returns the preview text of the found text result.
Returns
- Returns short preview excerpt of the found text.
public 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.
public 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.
public String getUid ()
Returns UID of the document this preview result belongs to.
Returns
- UID of the owner document.