org.apache.jackrabbit.spi.commons.query

Class QueryRootNode

java.lang.Object

org.apache.jackrabbit.spi.commons.query.QueryNode

org.apache.jackrabbit.spi.commons.query.QueryRootNode

public class QueryRootNode
extends QueryNode

Implements the root node of a query tree.

Field Summary

Fields inherited from class org.apache.jackrabbit.spi.commons.query.QueryNode

TYPE_AND, TYPE_DEREF, TYPE_EXACT, TYPE_LOCATION, TYPE_NODETYPE, TYPE_NOT, TYPE_OR, TYPE_ORDER, TYPE_PATH, TYPE_PROP_FUNCTION, TYPE_RELATION, TYPE_ROOT, TYPE_TEXTSEARCH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueryRootNode() Creates a new QueryRootNode instance.

Method Summary

Modifier and Type	Method and Description
Object	accept(QueryNodeVisitor visitor, Object data) Accepts a QueryNodeVisitor and calls the appropriate visit method on the visitor depending on the concrete implementation of this QueryNode.
void	addSelectProperty(Name propName) Adds a new select property to the query.
boolean	equals(Object obj) Returns true if obj is the same type of QueryNode as this node and is equal to this node.
PathQueryNode	getLocationNode() Returns the PathQueryNode or null if this query does not have a location node.
OrderQueryNode	getOrderNode() Returns the order node or null if no order is specified.
Name[]	getSelectProperties() Returns an array of select properties.
int	getType() Returns the type of this node.
boolean	needsSystemTree() Returns true if this query node needs items under /jcr:system to be queried.
void	setLocationNode(PathQueryNode locationNode) Sets the location node.
void	setOrderNode(OrderQueryNode orderNode) Sets a new order node.

Methods inherited from class org.apache.jackrabbit.spi.commons.query.QueryNode

dump, getParent

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueryRootNode

protected QueryRootNode()

Creates a new QueryRootNode instance.

Method Detail

getLocationNode

public PathQueryNode getLocationNode()

Returns the PathQueryNode or null if this query does not have a location node.

Returns:

the PathQueryNode or null if this query does not have a location node.

setLocationNode

public void setLocationNode(PathQueryNode locationNode)

Sets the location node.

Parameters:

locationNode - the new location node.

addSelectProperty

public void addSelectProperty(Name propName)

Adds a new select property to the query.

Parameters:

propName - the name of the property to select.

getSelectProperties

public Name[] getSelectProperties()

Returns an array of select properties.

Returns:

an array of select properties.

getOrderNode

public OrderQueryNode getOrderNode()

Returns the order node or null if no order is specified.

Returns:

the order node.

setOrderNode

public void setOrderNode(OrderQueryNode orderNode)

Sets a new order node.

Parameters:

orderNode - the new order node.

accept

public Object accept(QueryNodeVisitor visitor,
                     Object data)
              throws RepositoryException

Accepts a QueryNodeVisitor and calls the appropriate visit method on the visitor depending on the concrete implementation of this QueryNode.

Specified by:

accept in class QueryNode

Parameters:

visitor - the visitor to call back.

data - arbitrary data for the visitor.

Returns:

the return value of the visitor.visit() call.

Throws:

RepositoryException

getType

public int getType()

Returns the type of this node.

Specified by:

getType in class QueryNode

Returns:

the type of this node.

equals

public boolean equals(Object obj)

Returns true if obj is the same type of QueryNode as this node and is equal to this node.

Specified by:

equals in class QueryNode

Parameters:

obj - the reference object with which to compare.

Returns:

true if obj is equal to this; false otherwise.

needsSystemTree

public boolean needsSystemTree()

Returns true if this query node needs items under /jcr:system to be queried.

Specified by:

needsSystemTree in class QueryNode

Returns:

true if this query node needs content under /jcr:system to be queried; false otherwise.