SearchResult.Builder


class SearchResult.Builder


Builder for SearchResult objects.

Summary

Public constructors

Builder(packageName: String, databaseName: String)

Constructs a new builder for SearchResult objects.

Public functions

SearchResult.Builder

Adds the informational ranking signal of the matched document in this SearchResult.

SearchResult.Builder

Adds a SearchResult that was joined by the JoinSpec.

SearchResult.Builder

Adds another match to this SearchResult.

SearchResult

Constructs a new SearchResult.

SearchResult.Builder
setDocument(document: Any)

Sets the document which matched.

SearchResult.Builder

Sets the document which matched.

SearchResult.Builder

Sets the map from schema type names to the list of their parent types.

SearchResult.Builder
setRankingSignal(rankingSignal: Double)

Sets the ranking signal of the matched document in this SearchResult.

Public constructors

Builder

Added in 1.1.0-alpha07
Builder(packageName: String, databaseName: String)

Constructs a new builder for SearchResult objects.

Parameters
packageName: String

the package name the matched document belongs to

databaseName: String

the database name the matched document belongs to.

Public functions

addInformationalRankingSignal

Added in 1.1.0-alpha07
fun addInformationalRankingSignal(rankingSignal: Double): SearchResult.Builder

Adds the informational ranking signal of the matched document in this SearchResult.

addJoinedResult

Added in 1.1.0-alpha07
fun addJoinedResult(joinedResult: SearchResult): SearchResult.Builder

Adds a SearchResult that was joined by the JoinSpec.

Parameters
joinedResult: SearchResult

The joined SearchResult to add.

addMatchInfo

Added in 1.1.0-alpha07
fun addMatchInfo(matchInfo: SearchResult.MatchInfo): SearchResult.Builder

Adds another match to this SearchResult.

build

Added in 1.1.0-alpha07
fun build(): SearchResult

Constructs a new SearchResult.

setDocument

Added in 1.1.0-alpha07
fun setDocument(document: Any): SearchResult.Builder

Sets the document which matched.

Parameters
document: Any

An instance of a class annotated with androidx.appsearch.annotation.Document.

Throws
androidx.appsearch.exceptions.AppSearchException

if an error occurs converting a document class into a GenericDocument.

setGenericDocument

Added in 1.1.0-alpha07
fun setGenericDocument(document: GenericDocument): SearchResult.Builder

Sets the document which matched.

setParentTypeMap

Added in 1.1.0-alpha07
@ExperimentalAppSearchApi
fun setParentTypeMap(
    parentTypeMap: (Mutable)Map<String!, (Mutable)List<String!>!>
): SearchResult.Builder

Sets the map from schema type names to the list of their parent types.

The map should include entries for the GenericDocument's own type and all of the nested documents' types.

Child types must appear before parent types in each list. Otherwise, the toDocumentClass method may not correctly identify the most concrete type. This could lead to unintended deserialization into a more general type instead of a more specific type.

Parent types should include transitive parents.

setRankingSignal

Added in 1.1.0-alpha07
fun setRankingSignal(rankingSignal: Double): SearchResult.Builder

Sets the ranking signal of the matched document in this SearchResult.