Package org.eclipse.rdf4j.query.algebra

Class Var

java.lang.Object

org.eclipse.rdf4j.query.algebra.AbstractQueryModelNode

org.eclipse.rdf4j.query.algebra.Var

All Implemented Interfaces:

Serializable, Cloneable, GraphPatternGroupable, QueryModelNode, ValueExpr, VariableScopeChange

public class Var
extends AbstractQueryModelNode
implements ValueExpr

A variable that can contain a Value.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Var()	Deprecated, for removal: This API element is subject to removal in a future version.
Var(String name)
Var(String name, boolean anonymous)
Var(String name, Value value)
Var(String name, Value value, boolean anonymous, boolean constant)

Method Summary

Modifier and Type	Method	Description
Var	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.
String	getName()
QueryModelNode	getParentNode()	Gets the node's parent.
String	getSignature()	Default implementation of QueryModelNode.getSignature() that prints the name of the node's class.
Value	getValue()
int	hashCode()
boolean	hasValue()
boolean	isAnonymous()
boolean	isConstant()
void	replaceChildNode(QueryModelNode current, QueryModelNode replacement)	Default implementation of QueryModelNode.replaceChildNode(QueryModelNode, QueryModelNode) that throws an IllegalArgumentException indicating that current is not a child node of this node.
void	replaceWith(QueryModelNode replacement)	Default implementation of QueryModelNode.replaceWith(QueryModelNode) that throws an IllegalArgumentException indicating that current is not a child node of this node.
void	setAnonymous(boolean anonymous)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setConstant(boolean constant)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setName(String name)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setParentNode(QueryModelNode parent)	Sets the node's parent.
void	setValue(Value value)	Deprecated, for removal: This API element is subject to removal in a future version.
<X extends Exception> void	visit(QueryModelVisitor<X> visitor)	Visits this node.
<X extends Exception> void	visitChildren(QueryModelVisitor<X> visitor)	Dummy implementation of QueryModelNode.visitChildren(org.eclipse.rdf4j.query.algebra.QueryModelVisitor<X>) that does nothing.

Methods inherited from class org.eclipse.rdf4j.query.algebra.AbstractQueryModelNode

getCardinality, getCostEstimate, getResultSizeActual, getResultSizeEstimate, getTotalTimeNanosActual, isCardinalitySet, isGraphPatternGroup, isVariableScopeChange, nullEquals, replaceNodeInList, resetCardinality, setCardinality, setCostEstimate, setGraphPatternGroup, setResultSizeActual, setResultSizeEstimate, setTotalTimeNanosActual, setVariableScopeChange, shouldCacheCardinality, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.rdf4j.query.algebra.QueryModelNode

getCostEstimate, getResultSizeActual, getResultSizeEstimate, getTotalTimeNanosActual, setCostEstimate, setResultSizeActual, setResultSizeEstimate, setTotalTimeNanosActual, toString

Constructor Detail

Var

@Deprecated(forRemoval=true,
            since="4.1.0")
public Var()

Deprecated, for removal: This API element is subject to removal in a future version.

Var

public Var(String name,
           Value value,
           boolean anonymous,
           boolean constant)

Var

public Var(String name)

Var

public Var(String name,
           boolean anonymous)

Var

public Var(String name,
           Value value)

Method Detail

setAnonymous

@Deprecated(forRemoval=true,
            since="4.1.0")
public void setAnonymous(boolean anonymous)

Deprecated, for removal: This API element is subject to removal in a future version.

isAnonymous

public boolean isAnonymous()

getName

public String getName()

setName

@Deprecated(forRemoval=true,
            since="4.1.0")
public void setName(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

setValue

@Deprecated(forRemoval=true,
            since="4.1.0")
public void setValue(Value value)

Deprecated, for removal: This API element is subject to removal in a future version.

hasValue

public boolean hasValue()

getValue

public Value getValue()

visit

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

Description copied from interface: QueryModelNode

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

Specified by:

visit in interface QueryModelNode

Throws:

X extends Exception

visitChildren

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

Description copied from class: AbstractQueryModelNode

Dummy implementation of QueryModelNode.visitChildren(org.eclipse.rdf4j.query.algebra.QueryModelVisitor<X>) that does nothing. Subclasses should override this method when they have child nodes.

Specified by:

visitChildren in interface QueryModelNode

Overrides:

visitChildren in class AbstractQueryModelNode

Throws:

X extends Exception

getParentNode

public QueryModelNode getParentNode()

Description copied from interface: QueryModelNode

Gets the node's parent.

Specified by:

getParentNode in interface QueryModelNode

Overrides:

getParentNode in class AbstractQueryModelNode

Returns:

The parent node, if any.

setParentNode

public void setParentNode(QueryModelNode parent)

Description copied from interface: QueryModelNode

Sets the node's parent.

Specified by:

setParentNode in interface QueryModelNode

Overrides:

setParentNode in class AbstractQueryModelNode

Parameters:

parent - The parent node for this node.

replaceChildNode

public void replaceChildNode(QueryModelNode current,
                             QueryModelNode replacement)

Description copied from class: AbstractQueryModelNode

Default implementation of QueryModelNode.replaceChildNode(QueryModelNode, QueryModelNode) that throws an IllegalArgumentException indicating that current is not a child node of this node.

Specified by:

replaceChildNode in interface QueryModelNode

Overrides:

replaceChildNode in class AbstractQueryModelNode

Parameters:

current - The current child node.

replacement - The new child node.

replaceWith

public void replaceWith(QueryModelNode replacement)

Description copied from class: AbstractQueryModelNode

Default implementation of QueryModelNode.replaceWith(QueryModelNode) that throws an IllegalArgumentException indicating that current is not a child node of this node.

Specified by:

replaceWith in interface QueryModelNode

Overrides:

replaceWith in class AbstractQueryModelNode

Parameters:

replacement - The new node.

getSignature

public String getSignature()

Description copied from class: AbstractQueryModelNode

Default implementation of QueryModelNode.getSignature() that prints the name of the node's class.

Specified by:

getSignature in interface QueryModelNode

Overrides:

getSignature in class AbstractQueryModelNode

Returns:

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

equals

public boolean equals(Object o)

Description copied from interface: QueryModelNode

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

Specified by:

equals in interface QueryModelNode

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Var clone()

Description copied from interface: QueryModelNode

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

Specified by:

clone in interface QueryModelNode

Specified by:

clone in interface ValueExpr

Overrides:

clone in class AbstractQueryModelNode

Returns:

A deep clone of this query model node.

isConstant

public boolean isConstant()

Returns:

Returns the constant.

setConstant

@Deprecated(forRemoval=true,
            since="4.1.0")
public void setConstant(boolean constant)

Deprecated, for removal: This API element is subject to removal in a future version.

Parameters:

constant - The constant to set.