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

FieldQueryNode

open class FieldQueryNode(var field: CharSequence?, var text: CharSequence?, var begin: Int, var end: Int) : QueryNodeImpl, FieldValuePairQueryNode<CharSequence> , TextableQueryNode

A FieldQueryNode represents a element that contains field/text tuple

Inheritors

QuotedFieldQueryNode

WildcardQueryNode

Constructors

constructor(field: CharSequence?, text: CharSequence?, begin: Int, end: Int)

Properties

The term's begin position.

override val children: MutableList<QueryNode>?

var end: Int

The term's end position.

open override var field: CharSequence?

The term's field

override val isLeaf: Boolean

verify if a node is a Leaf node

override val parent: QueryNode?

positionIncrement

var positionIncrement: Int

The term's position increment.

override val tagMap: Map<String, Any>

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

open override var text: CharSequence?

The term's text.

open override var value: CharSequence?

Returns the term.

Functions

override fun add(children: List<QueryNode>)

override fun add(child: QueryNode)

open override fun clone(): QueryNode

open override fun cloneTree(): FieldQueryNode

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

open override fun containsTag(tagName: String): Boolean

verify if a node contains a tag

getFieldAsString

fun getFieldAsString(): String?

returns null if the field was not specified in the query string

open override fun getTag(tagName: String): Any?

Returns object stored under that tag name

getTextAsString

fun getTextAsString(): String?

open override fun removeChildren(childNode: QueryNode)

Remove a child node

removeFromParent

open override fun removeFromParent()

Removes this query node from its parent.

override fun set(children: List<QueryNode>)

open override 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.

open override fun toQueryString(escaper: EscapeQuerySyntax): CharSequence

convert to a query string understood by the query parser

open override fun toString(): String

Every implementation of this class should return pseudo xml like this:

open override fun unsetTag(tagName: String)

Unset a tag. tagName will be converted to lowercase.