org.openrdf.query.algebra

Interface QueryModelNode

All Superinterfaces:

Cloneable

All Known Subinterfaces:

AggregateOperator, TupleExpr, UpdateExpr, ValueExpr

All Known Implementing Classes:

Add, AggregateOperatorBase, And, ArbitraryLengthPath, Avg, BinaryTupleOperator, BinaryValueOperator, BindingSetAssignment, BNodeGenerator, Bound, Clear, Coalesce, Compare, CompareAll, CompareAny, CompareSubQueryValueOperator, Copy, Count, Create, Datatype, DeleteData, DescribeOperator, Difference, Distinct, EmptySet, Exists, Extension, ExtensionElem, Filter, FunctionCall, Group, GroupConcat, GroupElem, If, In, InsertData, Intersection, IRIFunction, IsBNode, IsLiteral, IsNumeric, IsResource, IsURI, Join, Label, Lang, LangMatches, LeftJoin, Like, ListMemberOperator, Load, LocalName, MathExpr, Max, Min, Modify, Move, MultiProjection, Namespace, NAryValueOperator, Not, Or, Order, OrderElem, Projection, ProjectionElem, ProjectionElemList, QueryModelNodeBase, QueryRoot, Reduced, Regex, SameTerm, Sample, Service, SingletonSet, Slice, StatementPattern, Str, SubQueryValueOperator, Sum, UnaryTupleOperator, UnaryValueOperator, Union, ValueConstant, Var, ZeroLengthPath

public interface QueryModelNode
extends Cloneable

Main interface for all query model nodes.

Method Summary

Methods

Modifier and Type	Method and Description
QueryModelNode	clone() Returns a (deep) clone of this query model node.
boolean	equals(Object o) Returns true if this query model node and its children are recursively equal to o and its children.
QueryModelNode	getParentNode() Gets the node's parent.
String	getSignature() Returns the signature of this query model node.
void	replaceChildNode(QueryModelNode current, QueryModelNode replacement) Replaces one of the child nodes with a new node.
void	replaceWith(QueryModelNode replacement) Substitutes this node with a new node in the query model tree.
void	setParentNode(QueryModelNode parent) Sets the node's parent.
String	toString() Returns an indented print of the node tree, starting from this node.
<X extends Exception> void	visit(QueryModelVisitor<X> visitor) Visits this node.
<X extends Exception> void	visitChildren(QueryModelVisitor<X> visitor) Visits the children of this node.

Method Detail

visit

<X extends Exception> void visit(QueryModelVisitor<X> visitor)
           throws X extends Exception

Visits this node. The node reports itself to the visitor with the proper runtime type.

Throws:

X extends Exception

visitChildren

<X extends Exception> void visitChildren(QueryModelVisitor<X> visitor)
                   throws X extends Exception

Visits the children of this node. The node calls visit(QueryModelVisitor) on all of its child nodes.

Throws:

X extends Exception

getParentNode

QueryModelNode getParentNode()

Gets the node's parent.

Returns:

The parent node, if any.

setParentNode

void setParentNode(QueryModelNode parent)

Sets the node's parent.

Parameters:

parent - The parent node for this node.

replaceChildNode

void replaceChildNode(QueryModelNode current,
                    QueryModelNode replacement)

Replaces one of the child nodes with a new node.

Parameters:

current - The current child node.

replacement - The new child node.

Throws:

IllegalArgumentException - If current is not one of node's children.

ClassCastException - If replacement is of an incompatible type.

replaceWith

void replaceWith(QueryModelNode replacement)

Substitutes this node with a new node in the query model tree.

Parameters:

replacement - The new node.

Throws:

IllegalStateException - If this node does not have a parent node.

ClassCastException - If replacement is of an incompatible type.

equals

boolean equals(Object o)

Returns true if this query model node and its children are recursively equal to o and its children.

Overrides:

equals in class Object

toString

String toString()

Returns an indented print of the node tree, starting from this node.

Overrides:

toString in class Object

getSignature

String getSignature()

Returns the signature of this query model node. Signatures normally include the node's name and any parameters, but not parent or child nodes. This method is used by toString().

Returns:

The node's signature, e.g. SLICE (offset=10, limit=10).

clone

QueryModelNode clone()

Returns a (deep) clone of this query model node. This method recursively clones the entire node tree, starting from this nodes.

Returns:

A deep clone of this query model node.