SearchSuggestionSpec

public final class SearchSuggestionSpec
extends Object implements Parcelable

java.lang.Object
   ↳ android.app.appsearch.SearchSuggestionSpec


This class represents the specification logic for AppSearch. It can be used to set the filter and settings of search a suggestions.

Summary

Nested classes

class SearchSuggestionSpec.Builder

Builder for objects

Constants

int SUGGESTION_RANKING_STRATEGY_DOCUMENT_COUNT

Ranked by the document count that contains the term.

int SUGGESTION_RANKING_STRATEGY_NONE

No Ranking, results are returned in arbitrary order.

int SUGGESTION_RANKING_STRATEGY_TERM_FREQUENCY

Ranked by the term appear frequency.

Inherited constants

Fields

public static final Creator<SearchSuggestionSpec> CREATOR

Public methods

Map<StringList<String>> getFilterDocumentIds()

Returns the map of namespace and target document ids to search over.

List<String> getFilterNamespaces()

Returns the list of namespaces to search over.

Map<StringList<String>> getFilterProperties()

Returns the map of schema and target properties to search over.

List<String> getFilterSchemas()

Returns the list of schema to search the suggestion over.

int getMaximumResultCount()

Returns the maximum number of wanted suggestion that will be returned in the result object.

int getRankingStrategy()

Returns the ranking strategy.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

SUGGESTION_RANKING_STRATEGY_DOCUMENT_COUNT

Added in API level 34
public static final int SUGGESTION_RANKING_STRATEGY_DOCUMENT_COUNT

Ranked by the document count that contains the term.

Suppose the following document is in the index.

Doc1 contains: term1 term2 term2 term2
Doc2 contains: term1

Then, suppose that a search suggestion for "t" is issued with the DOCUMENT_COUNT, the returned SearchSuggestionResults will be: term1, term2. The term1 will have higher score and appear in the results first.

Constant Value: 0 (0x00000000)

SUGGESTION_RANKING_STRATEGY_NONE

Added in API level 34
public static final int SUGGESTION_RANKING_STRATEGY_NONE

No Ranking, results are returned in arbitrary order.

Constant Value: 2 (0x00000002)

SUGGESTION_RANKING_STRATEGY_TERM_FREQUENCY

Added in API level 34
public static final int SUGGESTION_RANKING_STRATEGY_TERM_FREQUENCY

Ranked by the term appear frequency.

Suppose the following document is in the index.

Doc1 contains: term1 term2 term2 term2
Doc2 contains: term1

Then, suppose that a search suggestion for "t" is issued with the TERM_FREQUENCY, the returned SearchSuggestionResults will be: term2, term1. The term2 will have higher score and appear in the results first.

Constant Value: 1 (0x00000001)

Fields

CREATOR

public static final Creator<SearchSuggestionSpec> CREATOR

Public methods

getFilterDocumentIds

Added in API level 34
public Map<StringList<String>> getFilterDocumentIds ()

Returns the map of namespace and target document ids to search over.

The keys of the returned map are namespaces, and the values are the target document ids in that namespace to search over.

If Builder#addFilterDocumentIds was never called, returns an empty map. In this case AppSearch will search over all namespace and document ids.

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

Returns
Map<StringList<String>> This value cannot be null.

getFilterNamespaces

Added in API level 34
public List<String> getFilterNamespaces ()

Returns the list of namespaces to search over.

If empty, will search over all namespaces.

Returns
List<String> This value cannot be null.

getFilterProperties

public Map<StringList<String>> getFilterProperties ()

Returns the map of schema and target properties to search over.

The keys of the returned map are schema types, and the values are the target property path in that schema to search over.

If Builder#addFilterPropertyPaths was never called, returns an empty map. In this case AppSearch will search over all schemas and properties.

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

Returns
Map<StringList<String>> This value cannot be null.

getFilterSchemas

Added in API level 34
public List<String> getFilterSchemas ()

Returns the list of schema to search the suggestion over.

If empty, will search over all schemas.

Returns
List<String> This value cannot be null.

getMaximumResultCount

Added in API level 34
public int getMaximumResultCount ()

Returns the maximum number of wanted suggestion that will be returned in the result object.

Returns
int

getRankingStrategy

Added in API level 34
public int getRankingStrategy ()

Returns the ranking strategy.

Returns
int Value is SUGGESTION_RANKING_STRATEGY_NONE, SUGGESTION_RANKING_STRATEGY_DOCUMENT_COUNT, or SUGGESTION_RANKING_STRATEGY_TERM_FREQUENCY

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES