com.bigdata.rdf.sparql.ast

Class ProjectionNode

java.lang.Object

com.bigdata.bop.CoreBaseBOp

com.bigdata.bop.ModifiableBOpBase

com.bigdata.rdf.sparql.ast.ASTBase

com.bigdata.rdf.sparql.ast.QueryNodeBase

com.bigdata.rdf.sparql.ast.SolutionModifierBase

com.bigdata.rdf.sparql.ast.ValueExpressionListBaseNode<AssignmentNode>

com.bigdata.rdf.sparql.ast.ProjectionNode

All Implemented Interfaces:

BOp, IQueryNode, IPropertySet, Serializable, Cloneable, Iterable<AssignmentNode>

public class ProjectionNode
extends ValueExpressionListBaseNode<AssignmentNode>

AST node modeling projected value expressions.

Note: "*" is modeled using an explicit variable whose name is *.

Version:

$Id$

Author:

Bryan Thompson

See Also:

Serialized Form

Field Summary

Fields inherited from class com.bigdata.bop.CoreBaseBOp

DEFAULT_INITIAL_CAPACITY

Fields inherited from interface com.bigdata.bop.BOp

NOANNS, NOARGS

Constructor Summary

Constructors

Constructor and Description
ProjectionNode()
ProjectionNode(BOp[] args, Map<String,Object> anns) Shallow copy constructor.
ProjectionNode(ProjectionNode op) Deep copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addProjectionExpression(AssignmentNode assignment)
void	addProjectionVar(VarNode var) Adds a variable to be projected.
boolean	excludeFromProjection(IVariable<?> var) Checks if the variable is "blacklisted" to be excluded from projection variables.
List<AssignmentNode>	getAssignmentProjections() Return the ordered subset of the value expressions which project a computed value expression which is not a bare variable.
Integer	getDescribeIterationLimit() Return the optional limit on the #of iterations for a DESCRIBE query.
DescribeModeEnum	getDescribeMode() Return the DescribeModeEnum that will be used to evaluate a DESCRIBE query.
Integer	getDescribeStatementLimit() Return the optional limit on the #of statements for a DESCRIBE query.
IVariable[]	getProjectionVars() Return the projected variables.
Set<IVariable<?>>	getProjectionVars(Set<IVariable<?>> vars) Return the projected variables.
Set<IVariable<?>>	getSelectExprVars(Set<IVariable<?>> vars) Collect the variables used by the SELECT EXPRESSIONS for this projection node.
IValueExpression[]	getValueExpressions() Return the IValueExpressions for this ProjectionNode.
boolean	isDistinct()
boolean	isReduced()
boolean	isWildcard()
void	setDescribeIterationLimit(int newValue) Set the optional limit on the #of iterations for a DESCRIBE query.
void	setDescribeMode(DescribeModeEnum describeMode) Set the DescribeModeEnum that will be used to evaluate a DESCRIBE query.
void	setDescribeStatementLimit(int newValue) Set the optional limit on the #of statements for a DESCRIBE query.
void	setDistinct(boolean distinct)
void	setReduced(boolean reduced)
void	setVarsToExcludeFromProjection(Set<IVariable<?>> vars) Makes a copy of vars the (new) black list for variables that are not to be treated as projection variables.
String	toString(int indent) The contract of this method at this level is under-specified.

Methods inherited from class com.bigdata.rdf.sparql.ast.ValueExpressionListBaseNode

addExpr, getExpr, isEmpty, iterator, size

Methods inherited from class com.bigdata.rdf.sparql.ast.QueryNodeBase

getQueryHints, toString

Methods inherited from class com.bigdata.rdf.sparql.ast.ASTBase

addExplainHint, getExplainHints, getQueryHint, getQueryHint, getQueryHintAsBoolean, getQueryHintAsBoolean, getQueryHintAsInteger, replaceAllWith, setQueryHint, setQueryHints

Methods inherited from class com.bigdata.bop.ModifiableBOpBase

addArg, addArg, addArgIfAbsent, annotations, annotationsEqual, argIterator, args, arity, clearProperty, copyAll, get, getProperty, indexOf, removeArg, replaceWith, setArg, setArgs, setId, setProperty, setUnboundProperty, toArray, toArray

Methods inherited from class com.bigdata.bop.CoreBaseBOp

annotationsEqual, annotationsToString, annotationsToString, annotationValueToString, checkArgs, clone, equals, getEvaluationContext, getId, getProperty, getRequiredProperty, hashCode, indent, isController, mutation, shortenName, toShortString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bigdata.bop.BOp

annotations, argIterator, args, arity, clone, get, getEvaluationContext, getId, getProperty, getRequiredProperty, isController, setProperty, toArray, toArray, toShortString

Methods inherited from interface cutthecrap.utils.striterators.IPropertySet

getProperty

Constructor Detail

ProjectionNode

public ProjectionNode()

ProjectionNode

public ProjectionNode(ProjectionNode op)

Deep copy constructor.

ProjectionNode

public ProjectionNode(BOp[] args,
              Map<String,Object> anns)

Shallow copy constructor.

Method Detail

setDistinct

public void setDistinct(boolean distinct)

isDistinct

public boolean isDistinct()

setReduced

public void setReduced(boolean reduced)

isReduced

public boolean isReduced()

isWildcard

public boolean isWildcard()

getDescribeMode

public DescribeModeEnum getDescribeMode()

Return the DescribeModeEnum that will be used to evaluate a DESCRIBE query.

Note: The default is governed by .

Returns:

The DescribeModeEnum or null if this has not been explicitly specified.

setDescribeMode

public void setDescribeMode(DescribeModeEnum describeMode)

Set the DescribeModeEnum that will be used to evaluate a DESCRIBE query.

Note: The default is governed by .

Parameters:

describeMode - The DescribeModeEnum or null to use the default.

See Also:

Annotations#DESCRIBE_MODE

getDescribeIterationLimit

public Integer getDescribeIterationLimit()

Return the optional limit on the #of iterations for a DESCRIBE query.

Returns:

The limit -or- null.

See Also:

Annotations#DESCRIBE_ITERATION_LIMIT

getDescribeStatementLimit

public Integer getDescribeStatementLimit()

Return the optional limit on the #of statements for a DESCRIBE query.

Returns:

The limit -or- null.

See Also:

Annotations#DESCRIBE_STATEMENT_LIMIT

setDescribeIterationLimit

public void setDescribeIterationLimit(int newValue)

Set the optional limit on the #of iterations for a DESCRIBE query.

setDescribeStatementLimit

public void setDescribeStatementLimit(int newValue)

Set the optional limit on the #of statements for a DESCRIBE query.

addProjectionVar

public void addProjectionVar(VarNode var)

Adds a variable to be projected. The variable is modeled as an assignment of itself to itself, so everything in the projection node winds up looking like an assignment.

Parameters:

var - The variable.

addProjectionExpression

public void addProjectionExpression(AssignmentNode assignment)

setVarsToExcludeFromProjection

public void setVarsToExcludeFromProjection(Set<IVariable<?>> vars)

Makes a copy of vars the (new) black list for variables that are not to be treated as projection variables. This feature is useful for auxiliary aliases.

getAssignmentProjections

public List<AssignmentNode> getAssignmentProjections()

Return the ordered subset of the value expressions which project a computed value expression which is not a bare variable. TODO Consistent API for getAssignmentProjections() and getProjectionVars().

getProjectionVars

public IVariable[] getProjectionVars()

Return the projected variables.

getProjectionVars

public Set<IVariable<?>> getProjectionVars(Set<IVariable<?>> vars)

Return the projected variables.

Parameters:

vars - A set into which the projected variables will be added.

Returns:

The caller's set.

excludeFromProjection

public boolean excludeFromProjection(IVariable<?> var)

Checks if the variable is "blacklisted" to be excluded from projection variables. This feature is useful for auxiliary aliases.

getSelectExprVars

public Set<IVariable<?>> getSelectExprVars(Set<IVariable<?>> vars)

Collect the variables used by the SELECT EXPRESSIONS for this projection node.

Note: This DOES NOT report the variables which are projected OUT of the query. It reports the variables on which those projected variables depend.

Parameters:

vars - The variables are inserted into this set.

Returns:

The caller's set.

getValueExpressions

public IValueExpression[] getValueExpressions()

Return the IValueExpressions for this ProjectionNode.

toString

public String toString(int indent)

Description copied from class: CoreBaseBOp

The contract of this method at this level is under-specified. Sub-classes may choose between: - return a string representation of the object, similar to the use of CoreBaseBOp.toString() Or: - return a pretty-print representation of the object with indent Note that the former contract may or may not include recursive descent through a tree-like object, whereas the latter almost certainly does.

Specified by:

toString in interface BOp

Specified by:

toString in interface IQueryNode

Overrides:

toString in class CoreBaseBOp

Returns: