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

ProximityQueryNode

class ProximityQueryNode : BooleanQueryNode

A ProximityQueryNode represents a query where the terms should meet specific distance conditions. (a b c) WITHIN INORDER ("a" "b" "c") WITHIN INORDER

TODO: Add this to the future standard Lucene parser/processor/builder

Constructors

ProximityQueryNode

constructor(clauses: List<QueryNode>, field: CharSequence?, type: ProximityQueryNode.Type, distance: Int, inorder: Boolean)

constructor(clauses: List<QueryNode>, field: CharSequence?, type: ProximityQueryNode.Type, inorder: Boolean)

Types

object Companion

class ProximityType

utility class containing the distance condition and number

enum Type : Enum<ProximityQueryNode.Type>

Distance condition: PARAGRAPH, SENTENCE, or NUMBER

Properties

override val children: MutableList<QueryNode>?

var distance: Int

var field: CharSequence?

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

val inorder: Boolean

override val isLeaf: Boolean

verify if a node is a Leaf node

override val parent: QueryNode?

var proximityType: ProximityQueryNode.Type

override val tagMap: Map<String, Any>

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

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

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

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.