SearchResult.MatchInfo

public @NonNull CharSequence getExactMatch()

Gets the exact term of the given entry that matched the query.

Class example 1: this returns "foo".

Class example 2: for the first MatchInfo, this returns "Test" and, for the second MatchInfo, this returns "Testing".

public @NonNull SearchResult.MatchRange getExactMatchRange()

Gets the MatchRange of the exact term of the given entry that matched the query.

Class example 1: this returns [29, 32].

Class example 2: for the first MatchInfo, this returns [0, 4] and, for the second MatchInfo, this returns [0, 7].

public @NonNull String getFullText()

Gets the full text corresponding to the given entry.

Class example 1: this returns "A commonly used fake word is foo. Another nonsense word that's used a lot is bar."

Class example 2: for the first MatchInfo, this returns "Test Name Jr." and, for the second MatchInfo, this returns "Testing 1 2 3".

public @NonNull String getPropertyPath()

Gets the property path corresponding to the given entry.

A property path is a '.' - delimited sequence of property names indicating which property in the document these snippets correspond to.

Example properties: 'body', 'sender.name', 'sender.emailaddress', etc. For class example 1 this returns "subject"

public @NonNull PropertyPath getPropertyPathObject()

Gets a PropertyPath object representing the property path corresponding to the given entry.

Methods such as getPropertyDocument accept a path as a string rather than a PropertyPath object. However, you may want to manipulate the path before getting a property document. This method returns a PropertyPath rather than a String for easier path manipulation, which can then be converted to a String.

public @NonNull CharSequence getSnippet()

Gets the snippet corresponding to the given entry.

Snippet - Provides a subset of the content to display. Only populated when requested maxSnippetSize >0. The size of this content can be changed by setMaxSnippetSize. Windowing is centered around the middle of the matched token with content on either side clipped to token boundaries.

Class example 1: this returns "foo. Another".

Class example 2: for the first MatchInfo, this returns "Test Name" and, for the second MatchInfo, this returns "Testing 1 2 3".

public @NonNull SearchResult.MatchRange getSnippetRange()

Gets the snippet MatchRange corresponding to the given entry.

Only populated when set maxSnippetSize >0 in setMaxSnippetSize.

Class example 1: this returns [29, 41].

Class example 2: for the first MatchInfo, this returns [0, 9] and, for the second MatchInfo, this returns [0, 13].

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SEARCH_RESULT_MATCH_INFO_SUBMATCH)
public @NonNull CharSequence getSubmatch()

Gets the exact term subsequence of the given entry that matched the query.

Class example 1: this returns "foo".

Class example 2: for the first MatchInfo, this returns "Test" and, for the second MatchInfo, this returns "Test".

This information may not be available depending on the backend and Android API level. To ensure it is available, call isFeatureSupported.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SEARCH_RESULT_MATCH_INFO_SUBMATCH)
public @NonNull SearchResult.MatchRange getSubmatchRange()

Gets the MatchRange of the exact term subsequence of the given entry that matched the query.

Class example 1: this returns [29, 32].

Class example 2: for the first MatchInfo, this returns [0, 4] and, for the second MatchInfo, this returns [0, 4].

This information may not be available depending on the backend and Android API level. To ensure it is available, call isFeatureSupported.