SearchResult.MatchInfo

public final class SearchResult.MatchInfo


This class represents match objects for any snippets that might be present in SearchResults from a 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 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,

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

Match-2

Summary

Nested types

Builder for MatchInfo objects.

Public methods

@NonNull CharSequence

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

@NonNull SearchResult.MatchRange

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

@NonNull String

Gets the full text corresponding to the given entry.

@NonNull String

Gets the property path corresponding to the given entry.

@NonNull PropertyPath

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

@NonNull CharSequence

Gets the snippet corresponding to the given entry.

@NonNull SearchResult.MatchRange

Gets the snippet MatchRange corresponding to the given entry.

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

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

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

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

Public methods

getExactMatch

Added in 1.1.0-alpha04
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".

getExactMatchRange

Added in 1.1.0-alpha04
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].

getFullText

Added in 1.1.0-alpha04
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".

getPropertyPath

Added in 1.1.0-alpha04
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"

getPropertyPathObject

Added in 1.1.0-alpha04
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.

getSnippet

Added in 1.1.0-alpha04
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".

getSnippetRange

Added in 1.1.0-alpha04
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].

getSubmatch

Added in 1.1.0-alpha04
@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.

getSubmatchRange

Added in 1.1.0-alpha04
@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.