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

PathQueryNode

class PathQueryNode(pathElements: List<PathQueryNode.QueryText>) : QueryNodeImpl

A PathQueryNode is used to store queries like /company/USA/California /product/shoes/brown. QueryText are objects that contain the text, begin position and end position in the query.

Example how the text parser creates these objects:

val values = ArrayList<PathQueryNode.QueryText>()
values.add(PathQueryNode.QueryText("company", 1, 7))
values.add(PathQueryNode.QueryText("USA", 9, 12))
values.add(PathQueryNode.QueryText("California", 14, 23))
val q: QueryNode = PathQueryNode(values)

Constructors

PathQueryNode

constructor(pathElements: List<PathQueryNode.QueryText>)

Types

QueryText

class QueryText(var value: CharSequence, var begin: Int, var end: Int) : Cloneable<PathQueryNode.QueryText>

Term text with a beginning and end position

Properties

children

override val children: MutableList<QueryNode>?

firstPathElement

val firstPathElement: CharSequence

Returns the CharSequence value of a specific QueryText element

isLeaf

override val isLeaf: Boolean

verify if a node is a Leaf node

parent

override val parent: QueryNode?

pathElements

var pathElements: List<PathQueryNode.QueryText>

Returns the a List with all QueryText elements

tagMap

override val tagMap: Map<String, Any>

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

Functions

add

override fun add(children: List<QueryNode>)

override fun add(child: QueryNode)

clone

open override fun clone(): QueryNode

cloneTree

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

containsTag

open override fun containsTag(tagName: String): Boolean

verify if a node contains a tag

getPathElement

fun getPathElement(index: Int): PathQueryNode.QueryText

Returns the a specific QueryText element

getPathElements

fun getPathElements(startIndex: Int): List<PathQueryNode.QueryText>

Returns a List QueryText element from position startIndex

getTag

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

Returns object stored under that tag name

removeChildren

open override fun removeChildren(childNode: QueryNode)

Remove a child node

removeFromParent

open override fun removeFromParent()

Removes this query node from its parent.

set

override fun set(children: List<QueryNode>)

setTag

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.

toQueryString

open override fun toQueryString(escaper: EscapeQuerySyntax): CharSequence

convert to a query string understood by the query parser

toString

open override fun toString(): String

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

unsetTag

open override fun unsetTag(tagName: String)

Unset a tag. tagName will be converted to lowercase.