SearchResult.TextMatchInfo

Kotlin |Java

@ExperimentalAppSearchApi
class SearchResult.TextMatchInfo

This class represents match objects for any text match snippets that might be present in SearchResults from a string query. Using this class, you can get:

the full text - all of the text in that String property
the exact term match - the 'term' (full word) that matched the query
the subterm match - the portion of the matched term that appears in the query
a suggested text snippet - a portion of the full text surrounding the exact term match, set to term boundaries. The size of the snippet is specified in setMaxSnippetSize

for each text match in the document.

Class Example 1:

A document contains the following text in property "subject":

"A commonly used fake word is foo. Another nonsense word that’s used a lot is bar."

If the queryExpression is "foo" and getMaxSnippetSize is 10,

getFullText returns "A commonly used fake word is foo. Another nonsense word that’s used a lot is bar."
getExactMatchRange returns [29, 32]
getExactMatch returns "foo"
getSubmatchRange returns [29, 32]
getSubmatch returns "foo"
getSnippetRange returns [26, 33]
getSnippet returns "is foo."

Class Example 2:

A document contains one property named "subject" and one property named "sender" which contains a "name" property. In this case, we will have 2 property paths: sender.name and subject.

Let sender.name = "Test Name Jr." and subject = "Testing 1 2 3"

If the queryExpression is "Test" with TERM_MATCH_PREFIX and getMaxSnippetSize is 10. We will have 2 matches:

Match-1

getFullText returns "Test Name Jr."
getExactMatchRange returns [0, 4]
getExactMatch returns "Test"
getSubmatchRange returns [0, 4]
getSubmatch returns "Test"
getSnippetRange returns [0, 9]
getSnippet returns "Test Name"

Match-2

getFullText returns "Testing 1 2 3"
getExactMatchRange returns [0, 7]
getExactMatch returns "Testing"
getSubmatchRange returns [0, 4]
getSubmatch returns "Test"
getSnippetRange returns [0, 9]
getSnippet returns "Testing 1"

Summary

Public constructors
`@ExperimentalAppSearchApi TextMatchInfo( exactMatchRangeStart: Int, exactMatchRangeEnd: Int, submatchRangeStart: Int, submatchRangeEnd: Int, snippetRangeStart: Int, snippetRangeEnd: Int )` Creates a new immutable TextMatchInfo.

Public functions
`CharSequence`	`@ExperimentalAppSearchApi getExactMatch()` Gets the exact term of the given entry that matched the query.
`SearchResult.MatchRange`	`@ExperimentalAppSearchApi getExactMatchRange()` Gets the `MatchRange` of the exact term of the given entry that matched the query.
`String`	`@ExperimentalAppSearchApi getFullText()` Gets the full text corresponding to the given entry.
`CharSequence`	`@ExperimentalAppSearchApi getSnippet()` Gets the snippet corresponding to the given entry.
`SearchResult.MatchRange`	`@ExperimentalAppSearchApi getSnippetRange()` Gets the snippet `TextMatchInfo` corresponding to the given entry.
`CharSequence`	`@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SEARCH_RESULT_MATCH_INFO_SUBMATCH) @ExperimentalAppSearchApi getSubmatch()` Gets the exact term subsequence of the given entry that matched the query.
`SearchResult.MatchRange`	`@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SEARCH_RESULT_MATCH_INFO_SUBMATCH) @ExperimentalAppSearchApi getSubmatchRange()` Gets the `MatchRange` of the exact term subsequence of the given entry that matched the query.

Public constructors

TextMatchInfo

Added in 1.1.0-rc01

@ExperimentalAppSearchApi
TextMatchInfo(
    exactMatchRangeStart: Int,
    exactMatchRangeEnd: Int,
    submatchRangeStart: Int,
    submatchRangeEnd: Int,
    snippetRangeStart: Int,
    snippetRangeEnd: Int
)

Creates a new immutable TextMatchInfo.

Parameters
`exactMatchRangeStart: Int`	the start of the exact `MatchRange` for the entry.
`exactMatchRangeEnd: Int`	the end of the exact `MatchRange` for the entry.
`submatchRangeStart: Int`	the start of the sub-match `MatchRange` for the entry.
`submatchRangeEnd: Int`	the end of the sub-match `MatchRange` for the entry.
`snippetRangeStart: Int`	the start of the snippet `MatchRange` for the entry.
`snippetRangeEnd: Int`	the end of the snippet `MatchRange` for the entry.

Public functions

getExactMatch

Added in 1.1.0-rc01

@ExperimentalAppSearchApi
fun getExactMatch(): CharSequence

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

Class example 1: this returns "foo".

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

getExactMatchRange

Added in 1.1.0-rc01

@ExperimentalAppSearchApi
fun getExactMatchRange(): SearchResult.MatchRange

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 TextMatchInfo, this returns [0, 4] and, for the second TextMatchInfo, this returns [0, 7].

getFullText

Added in 1.1.0-rc01

@ExperimentalAppSearchApi
fun getFullText(): String

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 TextMatchInfo, this returns "Test Name Jr." and, for the second TextMatchInfo, this returns "Testing 1 2 3".

getSnippet

Added in 1.1.0-rc01

@ExperimentalAppSearchApi
fun getSnippet(): CharSequence

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 TextMatchInfo, this returns "Test Name" and, for the second TextMatchInfo, this returns "Testing 1 2 3".

getSnippetRange

Added in 1.1.0-rc01

@ExperimentalAppSearchApi
fun getSnippetRange(): SearchResult.MatchRange

Gets the snippet TextMatchInfo 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 TextMatchInfo, this returns [0, 9] and, for the second TextMatchInfo, this returns [0, 13].

getSubmatch

Added in 1.1.0-rc01

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SEARCH_RESULT_MATCH_INFO_SUBMATCH)
@ExperimentalAppSearchApi
fun getSubmatch(): CharSequence

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 TextMatchInfo, this returns "Test" and, for the second TextMatchInfo, this returns "Test".

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

Throws
`java.lang.UnsupportedOperationException`	if `isFeatureSupported` is false.

getSubmatchRange

Added in 1.1.0-rc01

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

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 TextMatchInfo, this returns [0, 4] and, for the second TextMatchInfo, 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.

Throws
`java.lang.UnsupportedOperationException`	if `isFeatureSupported` is false.