nutrient/io.nutrient.domain.search/SearchState

SearchState

abstract class SearchState<R : SearchResult, Q>

Generic search state interface that can be used to search and manage the results

Parameters

: The type of the search result

: The type of the search query

Inheritors

TextSearchState

Constructors

SearchState

constructor()

Properties

emptyQuery

abstract val emptyQuery: Q

Initial query value and also the value to which the query is reset when the search is terminated

hasResults

val hasResults: Boolean

isCompleted

val isCompleted: Boolean

isIdle

val isIdle: Boolean

isSearching

val isSearching: Boolean

query

abstract val query: Q

The current search query

resultPages

val resultPages: Set<Int>

results

abstract val results: List<R>

Contains the search results

resultsMap

val resultsMap: Map<Int, List<R>>

Contains the search results, the map key is the page index

resultsQuery

abstract val resultsQuery: Q?

The query associated with the current results

selectedResult

val selectedResult: R?

selectedResultIndex

abstract val selectedResultIndex: Int

Index of currently selected result

size

val size: Int

Total amount of search results

status

abstract val status: SearchStatus

The current search status of the search

Functions

getResultAt

fun getResultAt(index: Int): R?

Returns the result at the given index or null if the index is out of bounds

hasResultsForPage

fun hasResultsForPage(pageIndex: Int): Boolean

indexOfResult

fun indexOfResult(result: R): Int

Depending on the amount of search results, this method is potentially faster than results.indexOf

isCompletedForQuery

fun isCompletedForQuery(query: Q): Boolean

resultsForPage

fun resultsForPage(pageIndex: Int): List<R>

sanitizeSelectionIndex

fun sanitizeSelectionIndex(lastSelectedIndex: Int): Int

Checks selectedResultIndex if it's still within the bounds of the result list and if not returns a valid index