SearchResult

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

Builder for SearchResult objects.

This class represents match objects for any snippets that might be present in SearchResults from a query.

Builder for MatchInfo objects.

Class providing the position range of matching information.

Public functions
String

Contains the database name that stored the GenericDocument.
T
<T> getDocument(documentClass: Class<T!>)

Contains the matching document, converted to the given document class.
T
<T> getDocument(
    documentClass: Class<T!>,
    documentClassMap: (Mutable)Map<String!, (Mutable)List<String!>!>?
)

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

Contains the matching GenericDocument.
(Mutable)List<Double!>

Returns the informational ranking signals of the GenericDocument, according to the expressions added in addInformationalRankingExpressions.
(Mutable)List<SearchResult!>

Gets a list of SearchResult joined from the join operation.
(Mutable)List<SearchResult.MatchInfo!>

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

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

Returns the ranking signal of the GenericDocument, according to the ranking strategy set in setRankingStrategy.

Public functions

getDatabaseName

Added in 1.1.0-alpha06
fun getDatabaseName(): String

Contains the database name that stored the GenericDocument.

Returns
String

Name of the database within which the document is stored

getDocument

Added in 1.1.0-alpha06
fun <T> getDocument(documentClass: Class<T!>): T

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

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

Parameters
documentClass: Class<T!>

the document class to be passed to toDocumentClass.
Returns
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
GenericDocument

getDocument

Added in 1.1.0-alpha06
fun <T> getDocument(
    documentClass: Class<T!>,
    documentClassMap: (Mutable)Map<String!, (Mutable)List<String!>!>?
): T

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

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

Parameters
documentClass: Class<T!>

the document class to be passed to toDocumentClass.
documentClassMap: (Mutable)Map<String!, (Mutable)List<String!>!>?

the document class map to be passed to toDocumentClass.
Returns
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
GenericDocument

getGenericDocument

Added in 1.1.0-alpha06
fun getGenericDocument(): GenericDocument

Contains the matching GenericDocument.

Returns
GenericDocument

Document object which matched the query.

getInformationalRankingSignals

Added in 1.1.0-alpha06
fun getInformationalRankingSignals(): (Mutable)List<Double!>

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

getJoinedResults

Added in 1.1.0-alpha06
fun getJoinedResults(): (Mutable)List<SearchResult!>

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
(Mutable)List<SearchResult!>

a List of SearchResults containing joined documents.

getMatchInfos

Added in 1.1.0-alpha06
fun getMatchInfos(): (Mutable)List<SearchResult.MatchInfo!>

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

Returns
(Mutable)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-alpha06
fun getPackageName(): String

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

Returns
String

Package name that stored the document

getRankingSignal

Added in 1.1.0-alpha06
fun getRankingSignal(): Double

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:

Returns
Double

Ranking signal of the document