queryparser/org.gnit.lucenekmp.queryparser.flexible.core.nodes/FieldableNode

FieldableNode

interface FieldableNode : QueryNode

A query node implements FieldableNode interface to indicate that its children and itself are associated to a specific field.

If it has any children which also implements this interface, it must ensure the children are associated to the same field.

Inheritors

FieldValuePairQueryNode

PhraseSlopQueryNode

TokenizedPhraseQueryNode

IntervalQueryNode

MultiPhraseQueryNode

RegexpQueryNode

Properties

abstract val children: MutableList<QueryNode>?

get Children nodes

abstract var field: CharSequence?

Returns the field associated to the node and every node under it.

abstract val isLeaf: Boolean

verify if a node is a Leaf node

abstract val parent: QueryNode?

abstract val tagMap: Map<String, Any>

Returns a map containing all tags attached to this query node.

Functions

abstract fun add(children: List<QueryNode>)

abstract fun add(child: QueryNode)

abstract fun cloneTree(): QueryNode

Recursive clone the QueryNode tree The tags are not copied to the new tree when you call the cloneTree() method

abstract fun containsTag(tagName: String): Boolean

verify if a node contains a tag

abstract fun getTag(tagName: String): Any?

Returns object stored under that tag name

abstract fun removeChildren(childNode: QueryNode)

Remove a child node

removeFromParent

abstract fun removeFromParent()

Removes this query node from its parent.

abstract fun set(children: List<QueryNode>)

abstract fun setTag(tagName: String, value: Any)

Associate the specified value with the specified tagName. If the tagName already exists, the old value is replaced. The tagName and value cannot be null. tagName will be converted to lowercase.

abstract fun toQueryString(escapeSyntaxParser: EscapeQuerySyntax): CharSequence

convert to a query string understood by the query parser

abstract fun unsetTag(tagName: String)

Unset a tag. tagName will be converted to lowercase.