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

BoostQueryNode

class BoostQueryNode(query: QueryNode, val value: Float) : QueryNodeImpl

A BoostQueryNode boosts the QueryNode tree which is under this node. So, it must only and always have one child.

The boost value may vary from 0.0 to 1.0.

Constructors

constructor(query: QueryNode, value: Float)

Properties

val child: QueryNode?

Returns the single child which this node boosts.

override val children: MutableList<QueryNode>?

override val isLeaf: Boolean

verify if a node is a Leaf node

override val parent: QueryNode?

override val tagMap: Map<String, Any>

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

val value: Float

the boost value, it may vary from 0.0 to 1.0

Functions

override fun add(children: List<QueryNode>)

override fun add(child: QueryNode)

open override fun clone(): QueryNode

open override fun cloneTree(): QueryNode

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

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

Returns object stored under that tag name

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(escapeSyntaxParser: 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.