SearchResult.Builder

Added in 1.1.0

Kotlin |Java

public final class SearchResult.Builder

Builder for SearchResult objects.

Summary

Public constructors
`Builder(@NonNull String packageName, @NonNull String databaseName)` Constructs a new builder for `SearchResult` objects.

Public methods
`@NonNull SearchResult.Builder`	`addInformationalRankingSignal(double rankingSignal)` Adds the informational ranking signal of the matched document in this SearchResult.
`@NonNull SearchResult.Builder`	`addJoinedResult(@NonNull SearchResult joinedResult)` Adds a `SearchResult` that was joined by the `JoinSpec`.
`@NonNull SearchResult.Builder`	`addMatchInfo(@NonNull SearchResult.MatchInfo matchInfo)` Adds another match to this SearchResult.
`@NonNull SearchResult`	`build()` Constructs a new `SearchResult`.
`@NonNull SearchResult.Builder`	`setDocument(@NonNull Object document)` Sets the document which matched.
`@NonNull SearchResult.Builder`	`setGenericDocument(@NonNull GenericDocument document)` Sets the document which matched.
`@NonNull SearchResult.Builder`	`@ExperimentalAppSearchApi setParentTypeMap(@NonNull Map<String, List<String>> parentTypeMap)` Sets the map from schema type names to the list of their parent types.
`@NonNull SearchResult.Builder`	`setRankingSignal(double rankingSignal)` Sets the ranking signal of the matched document in this SearchResult.

Public constructors

Builder

Added in 1.1.0

public Builder(@NonNull String packageName, @NonNull String databaseName)

Constructs a new builder for SearchResult objects.

Parameters
`@NonNull String packageName`	the package name the matched document belongs to
`@NonNull String databaseName`	the database name the matched document belongs to.

Public methods

addInformationalRankingSignal

Added in 1.1.0

public @NonNull SearchResult.Builder addInformationalRankingSignal(double rankingSignal)

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

addJoinedResult

Added in 1.1.0

public @NonNull SearchResult.Builder addJoinedResult(@NonNull SearchResult joinedResult)

Adds a SearchResult that was joined by the JoinSpec.

Parameters
`@NonNull SearchResult joinedResult`	The joined SearchResult to add.

addMatchInfo

Added in 1.1.0

public @NonNull SearchResult.Builder addMatchInfo(@NonNull SearchResult.MatchInfo matchInfo)

Adds another match to this SearchResult.

build

Added in 1.1.0

public @NonNull SearchResult build()

Constructs a new SearchResult.

setDocument

Added in 1.1.0

public @NonNull SearchResult.Builder setDocument(@NonNull Object document)

Sets the document which matched.

Parameters
`@NonNull Object document`	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

public @NonNull SearchResult.Builder setGenericDocument(@NonNull GenericDocument document)

Sets the document which matched.

setParentTypeMap

Added in 1.1.0

@ExperimentalAppSearchApi
public @NonNull SearchResult.Builder setParentTypeMap(@NonNull Map<String, List<String>> parentTypeMap)

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

public @NonNull SearchResult.Builder setRankingSignal(double rankingSignal)

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