PropertyDefinedNode

Added in 1.1.0

Kotlin |Java

@ExperimentalAppSearchApi
public final class PropertyDefinedNode implements FunctionNode

FunctionNode representing the `propertyDefined` query function.

The `propertyDefined` query function will return all documents of types that define the given property. This will include documents that do not have the property itself, so long as that property is a part of the document's schema.

If you need to restrict to documents that have >=1 value(s) populated for that property, see HasPropertyNode.

Summary

Public constructors
`PropertyDefinedNode(@NonNull PropertyPath propertyPath)` Constructor for a `PropertyDefinedNode` representing the query function `propertyDefined` that takes in a `PropertyPath`.

Public methods
`boolean`	`equals(Object o)`
`@NonNull String`	`getFunctionName()` Returns the name of the function represented by `PropertyDefinedNode`.
`@NonNull PropertyPath`	`getPropertyPath()` Returns the `PropertyPath` representing the property being checked for in the document.
`int`	`hashCode()`
`void`	`setPropertyPath(@NonNull PropertyPath property)` Sets the property being checked for in the document, as represented by `PropertyDefinedNode`.
`@NonNull String`	`toString()` Get the string representation of `PropertyDefinedNode`.

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`	`FUNCTION_NAME_HAS_PROPERTY = "hasProperty"` 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`	`FUNCTION_NAME_SEARCH = "search"` Name of the query function represented by `androidx.appsearch.ast.query.SearchNode`.
`static final String`	`FUNCTION_NAME_SEMANTIC_SEARCH = "semanticSearch"` Name of the query function represented by `androidx.appsearch.ast.query.SemanticSearchNode`.

Inherited methods

From androidx.appsearch.ast.Node

@NonNull List<Node>

getChildren()

Get a list of the node's child Nodes.

Public constructors

PropertyDefinedNode

Added in 1.1.0

public PropertyDefinedNode(@NonNull PropertyPath propertyPath)

Constructor for a PropertyDefinedNode representing the query function `propertyDefined` that takes in a PropertyPath.

Public methods

equals

public boolean equals(Object o)

getFunctionName

public @NonNull String getFunctionName()

Returns the name of the function represented by PropertyDefinedNode.

getPropertyPath

Added in 1.1.0

public @NonNull PropertyPath getPropertyPath()

Returns the PropertyPath representing the property being checked for in the document.

hashCode

public int hashCode()

setPropertyPath

Added in 1.1.0

public void setPropertyPath(@NonNull PropertyPath property)

Sets the property being checked for in the document, as represented by PropertyDefinedNode.

toString

public @NonNull String toString()

Get the string representation of PropertyDefinedNode.

The string representation of PropertyDefinedNode is the function name followed by the property path in quotes surrounded by parentheses.