GetSearchStringParameterNode

@ExperimentalAppSearchApi
public final class GetSearchStringParameterNode implements FunctionNode

FunctionNode that represents the getSearchStringParameter function.

The getSearchStringParameter function retrieves the String parameter stored at the index in the list provided by getSearchStringParameters.

The String parameter can be used in a query and is treated as plain text. It will be segmented, normalized, and stripped of punctuation. Operators such as AND will be treated as plain text while operators such as negation ("-") and property restricts (":") will be treated as punctuation and removed.

So for the query `foo OR getSearchStringParameter(0)`, where getSearchStringParameter(0) contains "bar AND sender:recipient", the string will be segmented into

  • bar
  • AND
  • sender
  • :
  • recipient
Then the punctuation will be removed and the remaining tokens ANDed together. This means the resulting query is equivalent to the query `foo OR (bar AND and AND sender AND recipient)`.

Summary

Public constructors
GetSearchStringParameterNode(int searchStringIndex)

Constructor for GetSearchStringParameterNode that takes in the index of the SearchString parameter provided in getSearchStringParameters.

Public methods
boolean
@NonNull String

Returns the name of the function represented by GetSearchStringParameterNode.
int

Returns the index of the SearchString parameter to be retrieved from getSearchStringParameters.
int
void
setSearchStringIndex(int searchStringIndex)

Sets the index of the SearchString parameter provided in getSearchStringParameters to be represented by GetSearchStringParameterNode.
@NonNull String

Returns the string representation of GetSearchStringParameterNode.

Inherited Constants
From androidx.appsearch.ast.FunctionNode
static final String
FUNCTION_NAME_GET_SEARCH_STRING_PARAMETER = "getSearchStringParameter"

Name of the query function represented by androidx.appsearch.ast.query.GetSearchStringParameterNode.
static final String

Name of the query function represented by androidx.appsearch.ast.query.HasPropertyNode.
static final String
FUNCTION_NAME_PROPERTY_DEFINED = "propertyDefined"

Name of the query function represented by androidx.appsearch.ast.query.PropertyDefinedNode.
static final String

Name of the query function represented by androidx.appsearch.ast.query.SearchNode.
static final String

Name of the query function represented by androidx.appsearch.ast.query.SemanticSearchNode.

Inherited methods
From androidx.appsearch.ast.Node
@NonNull List<Node>

Get a list of the node's child Nodes.

Public constructors

GetSearchStringParameterNode

Added in 1.1.0-alpha07
public GetSearchStringParameterNode(int searchStringIndex)

Constructor for GetSearchStringParameterNode that takes in the index of the SearchString parameter provided in getSearchStringParameters.

Public methods

equals

public boolean equals(Object o)

getFunctionName

Added in 1.1.0-alpha07
public @NonNull String getFunctionName()

Returns the name of the function represented by GetSearchStringParameterNode.

getSearchStringIndex

Added in 1.1.0-alpha07
public int getSearchStringIndex()

Returns the index of the SearchString parameter to be retrieved from getSearchStringParameters.

hashCode

public int hashCode()

setSearchStringIndex

Added in 1.1.0-alpha07
public void setSearchStringIndex(int searchStringIndex)

Sets the index of the SearchString parameter provided in getSearchStringParameters to be represented by GetSearchStringParameterNode.

toString

public @NonNull String toString()

Returns the string representation of GetSearchStringParameterNode.

The string representation of GetSearchStringParameterNode is the function name followed by the searchStringIndex surrounded by parentheses. For example, the string representation of GetSearchStringParameterNode(1) is `getSearchStringParameter(1)`.