PropertyRestrictNode

Kotlin |Java

@ExperimentalAppSearchApi
class PropertyRestrictNode : Node

Node that represents a property restrict.

A property restrict is an expression in the query language that allows a querier to restrict the results of a query expression to those contained in a given property path. Written as a query string, this node should be equivalent to the query `property:child`, where `property` is the property path to restrict results to and `child` is the query subexpression.

This node is a comparator that should correspond with HAS in the Google AIP EBNF Filtering Definition.

Summary

Public constructors
`PropertyRestrictNode(propertyPath: PropertyPath, childNode: Node)` Constructor for building a `PropertyRestrictNode` that represents a restriction on a query subexpression by some property i.e. the query `property:subexpression`.

Public functions
`Boolean`	`equals(o: Any!)`
`Node`	`getChild()` Get the subexpression in the property restriction as a `Node` (i.e. the right hand side of the property restrict sign (":")).
`(Mutable)List<Node!>`	`getChildren()` Get the child `Node` of `PropertyRestrictNode` as a list containing the only child `Node`.
`PropertyPath`	`getPropertyPath()` Get the `PropertyPath` in the property restriction (i.e. the left hand side of the property restrict sign (":")).
`Int`	`hashCode()`
`Unit`	`setChild(childNode: Node)` Set the query subexpression in the property restriction (i.e. the right hand side of the property restrict sign (":")).
`Unit`	`setPropertyPath(propertyPath: PropertyPath)` Set the `PropertyPath` in the property restriction (i.e. the left hand side of the property restrict sign (":")).
`String`	`toString()` Get the query string representation of `PropertyRestrictNode`.

Public constructors

PropertyRestrictNode

Added in 1.1.0-beta01

PropertyRestrictNode(propertyPath: PropertyPath, childNode: Node)

Constructor for building a PropertyRestrictNode that represents a restriction on a query subexpression by some property i.e. the query `property:subexpression`.

Parameters
`propertyPath: PropertyPath`	The property that will restrict results returned by the subexpression in the property restrict
`childNode: Node`	The subexpression to be restricted in the property restrict

Public functions

equals

fun equals(o: Any!): Boolean

getChild

Added in 1.1.0-beta01

fun getChild(): Node

Get the subexpression in the property restriction as a Node (i.e. the right hand side of the property restrict sign (":")).

getChildren

fun getChildren(): (Mutable)List<Node!>

Get the child Node of PropertyRestrictNode as a list containing the only child Node.

getPropertyPath

Added in 1.1.0-beta01

fun getPropertyPath(): PropertyPath

Get the PropertyPath in the property restriction (i.e. the left hand side of the property restrict sign (":")).

hashCode

fun hashCode(): Int

setChild

Added in 1.1.0-beta01

fun setChild(childNode: Node): Unit

Set the query subexpression in the property restriction (i.e. the right hand side of the property restrict sign (":")).

setPropertyPath

Added in 1.1.0-beta01

fun setPropertyPath(propertyPath: PropertyPath): Unit

Set the PropertyPath in the property restriction (i.e. the left hand side of the property restrict sign (":")).

toString

fun toString(): String

Get the query string representation of PropertyRestrictNode.

The string representation is the string representation of the property path joined from the left to the query sub expression surrounded in parentheses with the property restrict symbol (":").