org.sindice.siren.qparser.keyword.nodes

Class TwigQueryNode

java.lang.Object

org.apache.lucene.queryparser.flexible.core.nodes.QueryNodeImpl

org.sindice.siren.qparser.keyword.nodes.TwigQueryNode

All Implemented Interfaces:

Cloneable, org.apache.lucene.queryparser.flexible.core.nodes.FieldableNode, org.apache.lucene.queryparser.flexible.core.nodes.QueryNode

public class TwigQueryNode
extends org.apache.lucene.queryparser.flexible.core.nodes.QueryNodeImpl
implements org.apache.lucene.queryparser.flexible.core.nodes.FieldableNode

A TwigQueryNode represents a structured query, i.e., a TwigQuery.

It is composed of two nodes, a root and of a direct child.

A node with multiple children can be built by passing an ArrayQueryNode to the setChild(QueryNode).

A complex twig can be built by chaining multiple TwigQueryNode.

Field Summary

Fields inherited from class org.apache.lucene.queryparser.flexible.core.nodes.QueryNodeImpl

PLAINTEXT_FIELD_NAME, toQueryStringIgnoreFields

Constructor Summary

Constructors

Constructor and Description
TwigQueryNode(org.apache.lucene.queryparser.flexible.core.nodes.QueryNode root, org.apache.lucene.queryparser.flexible.core.nodes.QueryNode child) Build a TwigQueryNode where the root can be either an WildcardNodeQueryNode or a NodeBooleanQueryNode.

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.lucene.queryparser.flexible.core.nodes.QueryNode	getChild() Returns the child of the twig.
CharSequence	getField()
org.apache.lucene.queryparser.flexible.core.nodes.QueryNode	getRoot() Returns the root of the twig.
int	getRootLevel() Get the level of the root node in the document tree.
void	setChild(org.apache.lucene.queryparser.flexible.core.nodes.QueryNode child) Set the child of the twig.
void	setField(CharSequence fieldName)
void	setRoot(org.apache.lucene.queryparser.flexible.core.nodes.QueryNode root) Set the root of the twig
void	setRootLevel(int rootLevel) Set the level of the root node in the document tree.
CharSequence	toQueryString(org.apache.lucene.queryparser.flexible.core.parser.EscapeQuerySyntax escapeSyntaxParser)
String	toString()

Methods inherited from class org.apache.lucene.queryparser.flexible.core.nodes.QueryNodeImpl

add, add, allocate, clone, cloneTree, containsTag, getChildren, getParent, getTag, getTagMap, isDefaultField, isLeaf, isRoot, set, setLeaf, setTag, unsetTag

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.lucene.queryparser.flexible.core.nodes.QueryNode

add, add, cloneTree, containsTag, getChildren, getParent, getTag, getTagMap, isLeaf, set, setTag, unsetTag

Constructor Detail

TwigQueryNode

public TwigQueryNode(org.apache.lucene.queryparser.flexible.core.nodes.QueryNode root,
             org.apache.lucene.queryparser.flexible.core.nodes.QueryNode child)

Build a TwigQueryNode where the root can be either an WildcardNodeQueryNode or a NodeBooleanQueryNode. In addition to the root, the child node can be an ArrayQueryNode or another TwigQueryNode.

Parameters:

root - the QueryNode as the root of the twig

child - the QueryNode as the child of the twig

Method Detail

setRoot

public void setRoot(org.apache.lucene.queryparser.flexible.core.nodes.QueryNode root)

Set the root of the twig

getRoot

public org.apache.lucene.queryparser.flexible.core.nodes.QueryNode getRoot()

Returns the root of the twig.

setChild

public void setChild(org.apache.lucene.queryparser.flexible.core.nodes.QueryNode child)

Set the child of the twig.

getChild

public org.apache.lucene.queryparser.flexible.core.nodes.QueryNode getChild()

Returns the child of the twig.

setRootLevel

public void setRootLevel(int rootLevel)

Set the level of the root node in the document tree.

See Also:

NodeQuery.setLevelConstraint(int)

getRootLevel

public int getRootLevel()

Get the level of the root node in the document tree.

If no root level has been set, -1 is returned.

See Also:

NodeQuery.setLevelConstraint(int)

getField

public CharSequence getField()

Specified by:

getField in interface org.apache.lucene.queryparser.flexible.core.nodes.FieldableNode

setField

public void setField(CharSequence fieldName)

Specified by:

setField in interface org.apache.lucene.queryparser.flexible.core.nodes.FieldableNode

toString

public String toString()

Specified by:

toString in interface org.apache.lucene.queryparser.flexible.core.nodes.QueryNode

Overrides:

toString in class org.apache.lucene.queryparser.flexible.core.nodes.QueryNodeImpl

toQueryString

public CharSequence toQueryString(org.apache.lucene.queryparser.flexible.core.parser.EscapeQuerySyntax escapeSyntaxParser)

Specified by:

toQueryString in interface org.apache.lucene.queryparser.flexible.core.nodes.QueryNode