SearchResult

Added in 1.1.0

Kotlin |Java

public final class SearchResult

This class represents one of the results obtained from an AppSearch query.

This allows clients to obtain:

The document which matched, using getGenericDocument
Information about which properties in the document matched, and "snippet" information containing textual summaries of the document's matches, using getMatchInfos

"Snippet" refers to a substring of text from the content of document that is returned as a part of search result.

See also
`SearchResults`

Summary

Nested types
`public final class SearchResult.Builder` Builder for `SearchResult` objects.
`@ExperimentalAppSearchApi public final class SearchResult.EmbeddingMatchInfo` This class represents match objects for any snippets that might be present in `SearchResults` from an embedding query.
`public final class SearchResult.MatchInfo` This class represents match objects for any snippets that might be present in `SearchResults` from a query.
`public final class SearchResult.MatchInfo.Builder` Builder for `MatchInfo` objects.
`public final class SearchResult.MatchRange` Class providing the position range of a text match information.
`@ExperimentalAppSearchApi public final class SearchResult.TextMatchInfo` This class represents match objects for any text match snippets that might be present in `SearchResults` from a string query.

Public methods
`@NonNull String`	`getDatabaseName()` Contains the database name that stored the `GenericDocument`.
`@NonNull T`	`<T> getDocument(@NonNull Class<T> documentClass)` Contains the matching document, converted to the given document class.
`@NonNull T`	`<T> getDocument( @NonNull Class<T> documentClass, @Nullable Map<String, List<String>> documentClassMap )` Contains the matching document, converted to the given document class.
`@NonNull GenericDocument`	`getGenericDocument()` Contains the matching `GenericDocument`.
`@NonNull List<Double>`	`getInformationalRankingSignals()` Returns the informational ranking signals of the `GenericDocument`, according to the expressions added in addInformationalRankingExpressions.
`@NonNull List<SearchResult>`	`getJoinedResults()` Gets a list of `SearchResult` joined from the join operation.
`@NonNull List<SearchResult.MatchInfo>`	`getMatchInfos()` Returns a list of `MatchInfo`s providing information about how the document in `getGenericDocument` matched the query.
`@NonNull String`	`getPackageName()` Contains the package name of the app that stored the `GenericDocument`.
`@NonNull Map<String, List<String>>`	`@ExperimentalAppSearchApi getParentTypeMap()` Returns the map from schema type names to the list of their parent types.
`double`	`getRankingSignal()` Returns the ranking signal of the `GenericDocument`, according to the ranking strategy set in `setRankingStrategy`.

Public methods

getDatabaseName

Added in 1.1.0

public @NonNull String getDatabaseName()

Contains the database name that stored the GenericDocument.

Returns
`@NonNull String`	Name of the database within which the document is stored

getDocument

Added in 1.1.0

public @NonNull T <T> getDocument(@NonNull Class<T> documentClass)

Contains the matching document, converted to the given document class.

This is equivalent to calling getGenericDocument().toDocumentClass(T.class).

Calling this function repeatedly is inefficient. Prefer to retain the object returned by this function, rather than calling it multiple times.

Parameters
`@NonNull Class<T> documentClass`	the document class to be passed to `toDocumentClass`.

Returns
`@NonNull T`	Document object which matched the query.

Throws
`androidx.appsearch.exceptions.AppSearchException`	if no factory for this document class could be found on the classpath.

See also
`toDocumentClass`

getDocument

Added in 1.1.0

public @NonNull T <T> getDocument(
    @NonNull Class<T> documentClass,
    @Nullable Map<String, List<String>> documentClassMap
)

Contains the matching document, converted to the given document class.

This is equivalent to calling getGenericDocument().toDocumentClass(T.class, new DocumentClassMappingContext(documentClassMap, getParentTypeMap())).

Calling this function repeatedly is inefficient. Prefer to retain the object returned by this function, rather than calling it multiple times.

Parameters
`@NonNull Class<T> documentClass`	the document class to be passed to `toDocumentClass`.
`@Nullable Map<String, List<String>> documentClassMap`	A map from AppSearch's type name specified by `name` to the list of the fully qualified names of the corresponding document classes. In most cases, passing the value returned by `getGlobalMap` will be sufficient.

Returns
`@NonNull T`	Document object which matched the query.

Throws
`androidx.appsearch.exceptions.AppSearchException`	if no factory for this document class could be found on the classpath.

See also
`toDocumentClass`

getGenericDocument

Added in 1.1.0

public @NonNull GenericDocument getGenericDocument()

Contains the matching GenericDocument.

Returns
`@NonNull GenericDocument`	Document object which matched the query.

getInformationalRankingSignals

Added in 1.1.0

public @NonNull List<Double> getInformationalRankingSignals()

Returns the informational ranking signals of the GenericDocument, according to the expressions added in addInformationalRankingExpressions.

getJoinedResults

Added in 1.1.0

public @NonNull List<SearchResult> getJoinedResults()

Gets a list of SearchResult joined from the join operation.

These joined documents match the outer document as specified in the JoinSpec with parentPropertyExpression and childPropertyExpression. They are ordered according to the getNestedSearchSpec, and as many SearchResults as specified by getMaxJoinedResultCount will be returned. If no JoinSpec was specified, this returns an empty list.

This method is inefficient to call repeatedly, as new SearchResult objects are created each time.

Returns
`@NonNull List<SearchResult>`	a List of SearchResults containing joined documents.

getMatchInfos

Added in 1.1.0

public @NonNull List<SearchResult.MatchInfo> getMatchInfos()

Returns a list of MatchInfos providing information about how the document in getGenericDocument matched the query.

Returns
`@NonNull List<SearchResult.MatchInfo>`	List of matches based on `SearchSpec`. If snippeting is disabled using `setSnippetCount` or `setSnippetCountPerProperty`, for all results after that value, this method returns an empty list.

getPackageName

Added in 1.1.0

public @NonNull String getPackageName()

Contains the package name of the app that stored the GenericDocument.

Returns
`@NonNull String`	Package name that stored the document

getParentTypeMap

Added in 1.1.0

@ExperimentalAppSearchApi
public @NonNull Map<String, List<String>> getParentTypeMap()

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

The map includes entries for the GenericDocument's own type and all of the nested documents' types. Child types are guaranteed to appear before parent types in each list.

Parent types include transitive parents.

Calling this function repeatedly is inefficient. Prefer to retain the Map returned by this function, rather than calling it multiple times.

getRankingSignal

Added in 1.1.0

public double getRankingSignal()

Returns the ranking signal of the GenericDocument, according to the ranking strategy set in setRankingStrategy. The meaning of the ranking signal and its value is determined by the selected ranking strategy:

RANKING_STRATEGY_NONE - this value will be 0
RANKING_STRATEGY_DOCUMENT_SCORE - the value returned by calling getScore on the document returned by getGenericDocument
RANKING_STRATEGY_CREATION_TIMESTAMP - the value returned by calling getCreationTimestampMillis on the document returned by getGenericDocument
RANKING_STRATEGY_RELEVANCE_SCORE - an arbitrary double value where a higher value means more relevant
RANKING_STRATEGY_USAGE_COUNT - the number of times usage has been reported for the document returned by getGenericDocument
RANKING_STRATEGY_USAGE_LAST_USED_TIMESTAMP - the timestamp of the most recent usage that has been reported for the document returned by getGenericDocument

Returns
`double`	Ranking signal of the document

SearchResult

Summary

Nested types

Public methods

Public methods

getDatabaseName

getDocument

getDocument

getGenericDocument

getInformationalRankingSignals

getJoinedResults

getMatchInfos

getPackageName

getParentTypeMap

getRankingSignal