pspdfkit/com.pspdfkit.document.library/PdfLibrary

PdfLibrary

class PdfLibrary

PdfLibrary implements a SQLite-based full-text-search engine. You can register documents to be indexed in the background and then search for keywords within that collection. There can be multiple libraries, although usually one is enough for the common use case.

See also

<a

href="https://pspdfkit.com/guides/android/current/features/indexed-full-text-search/">Indexed Full text search

Types

@Retention(value = SOURCE)

annotation class Tokenizer

Properties

PORTER_TOKENIZER

val PORTER_TOKENIZER: String = "PorterTokenizer"

The name of PSPDFKit's custom porter tokenizer that allows better CJK indexing.

UNICODE_TOKENIZER

val UNICODE_TOKENIZER: String = "UnicodeTokenizer"

The name of PSPDFKit's custom Unicode tokenizer.

Functions

addLibraryIndexingListener

open fun addLibraryIndexingListener(@NonNull listener: LibraryIndexingListener)

Adds a LibraryIndexingListener to monitor document indexing status.

open fun clearIndex()

Completely clears the index for this library.

enqueueDocuments

open fun enqueueDocuments(@NonNull documents: List<PdfDocument>)

open fun enqueueDocuments(@NonNull documents: List<PdfDocument>, @NonNull indexingOptions: IndexingOptions)

Queues an array of documents for indexing.

enqueueDocumentSources

open fun enqueueDocumentSources(@NonNull documentSources: List<DocumentSource>)

Queues an array of documents for indexing.

enqueueDocumentSourcesWithMetadata

open fun enqueueDocumentSourcesWithMetadata(@NonNull documentSources: List<Pair<DocumentSource, Array<Byte>>>)

Queues an array of documents for indexing together with passed free-form metadata.

enqueueDocumentsWithMetadata

open fun enqueueDocumentsWithMetadata(@NonNull documents: List<Pair<PdfDocument, Array<Byte>>>)

open fun enqueueDocumentsWithMetadata(@NonNull documents: List<Pair<PdfDocument, Array<Byte>>>, @NonNull indexingOptions: IndexingOptions)

Queues an array of documents for indexing together with passed free-form metadata.

open fun get(@NonNull path: String): PdfLibrary

open fun get(@NonNull path: String, @NonNull tokenizer: String): PdfLibrary

Returns a library for a given path.

open fun getIndexedUIDs(): List<String>

Returns list of UIDs of documents currently indexed.

getIndexStatusForUID

open fun getIndexStatusForUID(@NonNull uid: String): LibraryIndexStatus

Returns indexing status for a document with passed UID.

getMetadataForUID

open fun getMetadataForUID(@NonNull uid: String): Array<Byte>

Returns metadata appended to document with enqueueDocumentsWithMetadata call.

open fun getQueuedUIDs(): List<String>

Returns list of UIDs of documents queued for indexing.

getSaveReverseText

open fun getSaveReverseText(): Boolean

Indicates whether saving the reverse text is enabled.

open fun isIndexing(): Boolean

Indicates whether the indexing is in progress or not.

removeDocuments

open fun removeDocuments(@NonNull documentUIDs: List<String>)

Invalidates index for documents.

removeLibraryIndexingListener

open fun removeLibraryIndexingListener(@NonNull listener: LibraryIndexingListener)

Removes a registered LibraryIndexingListener added with addLibraryIndexingListener.

open fun search(@NonNull searchString: String, @Nullable options: QueryOptions, @NonNull resultListener: QueryResultListener)

Query the database for a match of searchString.

setSaveReverseText

open fun setSaveReverseText(saveReverseText: Boolean)

Will save a reversed copy of the original page text.

open fun size(): Int

Returns number of indexed documents in this library.

open fun stopSearch()

Stops search and all in-progress preview text generator tasks.