public class

QueryOptions

extends Object
java.lang.Object
   ↳ com.pspdfkit.document.library.QueryOptions

Class Overview

Detailed options for querying the FTS database.

Summary

Nested Classes
class QueryOptions.Builder Builder used to construct QueryOptions instance. 
Public Methods
int getMaximumPreviewResultsPerDocument()
Returns maximum number of preview results in each document.
int getMaximumPreviewResultsTotal()
Returns maximum number of preview results for the search query.
int getMaximumSearchResultsPerDocument()
Returns maximum number of results in each document.
int getMaximumSearchResultsTotal()
Returns maximum number of results for the search query.
Range getPreviewRange()
Returns length of text preview snippet.
boolean shouldGenerateTextPreviews()
Indicates whether text previews should be generated.
boolean shouldIgnoreAnnotations()
Indicates whether annotations should be ignored when querying.
boolean shouldIgnoreDocumentText()
Indicates whether document text should be ignored when querying.
boolean shouldMatchExactPhrases()
Indicates whether exact phrases should be matched.
boolean shouldMatchExactWords()
Indicates whether exact words should be matched when searching.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public int getMaximumPreviewResultsPerDocument ()

Returns maximum number of preview results in each document.

Returns
  • Maximum number of preview results per document.

public int getMaximumPreviewResultsTotal ()

Returns maximum number of preview results for the search query.

Returns
  • Maximum number of preview results in the search query.

public int getMaximumSearchResultsPerDocument ()

Returns maximum number of results in each document.

Returns
  • Maximum number of results per document.

public int getMaximumSearchResultsTotal ()

Returns maximum number of results for the search query.

Returns
  • Maximum number of results in the search query

public Range getPreviewRange ()

Returns length of text preview snippet.

Returns
  • Pair of (starting position, length) representing search preview snippet start and length.

public boolean shouldGenerateTextPreviews ()

Indicates whether text previews should be generated.

Returns
  • true if text previews should be generated, false otherwise.

public boolean shouldIgnoreAnnotations ()

Indicates whether annotations should be ignored when querying.

Returns
  • true if annotations should be ignored, false if they should be included.

public boolean shouldIgnoreDocumentText ()

Indicates whether document text should be ignored when querying.

Returns
  • true if document text should be ignored, false if it should be included.

public boolean shouldMatchExactPhrases ()

Indicates whether exact phrases should be matched.

Returns
  • true if exact phrases should be matched, false otherwise.

public boolean shouldMatchExactWords ()

Indicates whether exact words should be matched when searching.

Returns
  • true if exact words should be matched, false otherwise.