public static final class

QueryOptions.Builder

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

Class Overview

Builder used to construct QueryOptions instance.

By default the number of returned search results is limited to 500 to limit possible search time. Use maximumPreviewResultsTotal(int) and maximumSearchResultsTotal(int) to change this default.

Summary

Public Constructors
Builder()
Public Methods
QueryOptions build()
Builds query options.
QueryOptions.Builder generateTextPreviews(boolean generatePreviews)
Enables generation of search preview snippets.
QueryOptions.Builder ignoreAnnotations(boolean ignoreAnnotations)
Prevents querying of indexed annotations.
QueryOptions.Builder ignoreDocumentText(boolean ignoreDocumentText)
Prevents querying of indexed document text.
QueryOptions.Builder matchExactPhrases(boolean matchExactPhrases)
Enables exact phrase matching.
QueryOptions.Builder matchExactWords(boolean matchExactWords)
Enables exact word matching.
QueryOptions.Builder maximumPreviewResultsPerDocument(int maximumPreviewResultsPerDocument)
Sets a limit of preview results in each document.
QueryOptions.Builder maximumPreviewResultsTotal(int maximumPreviewResultsTotal)
Sets a limit of all preview results.
QueryOptions.Builder maximumSearchResultsPerDocument(int maximumSearchResultsPerDocument)
Sets a limit of search results in each document.
QueryOptions.Builder maximumSearchResultsTotal(int maximumSearchResultsTotal)
Sets a limit of all search results.
QueryOptions.Builder previewRange(int start, int length)
Sets range for the preview generated.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Builder ()

Public Methods

public QueryOptions build ()

Builds query options.

Returns

public QueryOptions.Builder generateTextPreviews (boolean generatePreviews)

Enables generation of search preview snippets.

Parameters
generatePreviews true to enable search previews. false by default.

public QueryOptions.Builder ignoreAnnotations (boolean ignoreAnnotations)

Prevents querying of indexed annotations.

Parameters
ignoreAnnotations true to ignore indexed annotation content in the query. false by default.

public QueryOptions.Builder ignoreDocumentText (boolean ignoreDocumentText)

Prevents querying of indexed document text.

Parameters
ignoreDocumentText true to ignore indexed document text in the query. false by default.

public QueryOptions.Builder matchExactPhrases (boolean matchExactPhrases)

Enables exact phrase matching.

Parameters
matchExactPhrases true to enable exact phrase matching. false by default.

public QueryOptions.Builder matchExactWords (boolean matchExactWords)

Enables exact word matching.

Parameters
matchExactWords true to enable exact word matching. false by default.

public QueryOptions.Builder maximumPreviewResultsPerDocument (int maximumPreviewResultsPerDocument)

Sets a limit of preview results in each document.

Parameters
maximumPreviewResultsPerDocument Maximum number of preview results in each document. Unlimited by default.

public QueryOptions.Builder maximumPreviewResultsTotal (int maximumPreviewResultsTotal)

Sets a limit of all preview results.

Parameters
maximumPreviewResultsTotal Maximum returned preview results for this query. Unlimited by default.

public QueryOptions.Builder maximumSearchResultsPerDocument (int maximumSearchResultsPerDocument)

Sets a limit of search results in each document.

Parameters
maximumSearchResultsPerDocument Maximum number of search results in each document. Unlimited by default.

public QueryOptions.Builder maximumSearchResultsTotal (int maximumSearchResultsTotal)

Sets a limit of all search results.

Parameters
maximumSearchResultsTotal Maximum returned search results for this query. Unlimited by default.

public QueryOptions.Builder previewRange (int start, int length)

Sets range for the preview generated.

Parameters
start Starting index of preview snippet to be generated.
length Length of preview snippet to be generated.