colibrio-reader-framework/com.colibrio.readingsystem.base/TextSearchQueryOptions

TextSearchQueryOptions

data class TextSearchQueryOptions(val ignoreCase: Boolean = true, val searchResultOptions: TextSearchResultOptions = TextSearchResultOptions(), val whitespaceMode: TextSearchQueryWhitespaceMode = TextSearchQueryWhitespaceMode.COLLAPSE)

Options object used with ReaderDocumentSearch.createTextQuery.

Constructors

TextSearchQueryOptions

fun TextSearchQueryOptions(ignoreCase: Boolean = true, searchResultOptions: TextSearchResultOptions = TextSearchResultOptions(), whitespaceMode: TextSearchQueryWhitespaceMode = TextSearchQueryWhitespaceMode.COLLAPSE)

Types

object Companion

Functions

fun serialize(generator: JsonGenerator)

Properties

val ignoreCase: Boolean = true

If set to true, character casing is ignored.

searchResultOptions

val searchResultOptions: TextSearchResultOptions

Options for search result items.

val whitespaceMode: TextSearchQueryWhitespaceMode

Controls how whitespace should be treated in the source content. See TextSearchQueryWhitespaceMode for a description of each mode.