com.bigdata.rdf.sparql.ast

Class NamedSubqueryInclude

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.GroupMemberNodeBase<NamedSubqueryInclude>

com.bigdata.rdf.sparql.ast.NamedSubqueryInclude

All Implemented Interfaces:

BOp, IBindingProducerNode, IGroupMemberNode, IJoinNode, INamedSolutionSet, IQueryNode, IVariableBindingRequirements, IPropertySet, Serializable, Cloneable

public class NamedSubqueryInclude
extends GroupMemberNodeBase<NamedSubqueryInclude>
implements IJoinNode, INamedSolutionSet

An AST node which provides a reference in an IGroupNode and indicates that a named solution set should be joined with the solutions in the group.

Version:

$Id$

Author:

Bryan Thompson

See Also:

NamedSubqueryRoot, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NamedSubqueryInclude.Annotations

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
NamedSubqueryInclude(BOp[] args, Map<String,Object> anns) Required shallow copy constructor.
NamedSubqueryInclude(NamedSubqueryInclude op) Constructor required for com.bigdata.bop.BOpUtility#deepCopy(FilterNode).
NamedSubqueryInclude(String name)

Method Summary

Methods

Modifier and Type	Method and Description
List<FilterNode>	getAttachedJoinFilters() Return the FILTER(s) associated with this IJoinNode.
Set<IVariable<?>>	getDesiredBound(StaticAnalysis sa) Get variables that are not required to be bound, but desired in the sense that we want them to be bound when evaluating the construct.
VarNode[]	getJoinVars() The join variables to be used when the named result set is included into the query.
Set<IVariable<?>>	getJoinVarSet() Return the ordered set of join variables.
String	getName() Return the name of the solution set.
Set<IVariable<?>>	getRequiredBound(StaticAnalysis sa) Return the variables used in the node that *must* be bound prior to evaluating the node.
boolean	isMinus() Returns false.
boolean	isOptional() Returns false.
void	setAttachedJoinFilters(List<FilterNode> filters)
void	setJoinVars(VarNode[] joinVars) Set the join variables.
void	setName(String name) Set the name of the solution set.
String	toString(int indent) The contract of this method at this level is under-specified.

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

getContext, getParent, getParentGraphPatternGroup, getParentJoinGroup, setParent

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, toString

Methods inherited from interface cutthecrap.utils.striterators.IPropertySet

getProperty

Constructor Detail

NamedSubqueryInclude

public NamedSubqueryInclude(NamedSubqueryInclude op)

Constructor required for com.bigdata.bop.BOpUtility#deepCopy(FilterNode).

NamedSubqueryInclude

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

Required shallow copy constructor.

NamedSubqueryInclude

public NamedSubqueryInclude(String name)

Parameters:

name - The name of the subquery result set.

Method Detail

getName

public String getName()

Description copied from interface: INamedSolutionSet

Return the name of the solution set.

Specified by:

getName in interface INamedSolutionSet

Returns:

The name of the solution set.

setName

public void setName(String name)

Description copied from interface: INamedSolutionSet

Set the name of the solution set.

Specified by:

setName in interface INamedSolutionSet

Parameters:

name - The name of the solution set.

getJoinVars

public VarNode[] getJoinVars()

The join variables to be used when the named result set is included into the query.

setJoinVars

public void setJoinVars(VarNode[] joinVars)

Set the join variables.

Parameters:

joinVars - The join variables.

getJoinVarSet

public Set<IVariable<?>> getJoinVarSet()

Return the ordered set of join variables.

Returns:

The ordered set of join variables and never null.

isOptional

public final boolean isOptional()

Returns false.

Specified by:

isOptional in interface IJoinNode

isMinus

public final boolean isMinus()

Returns false.

Specified by:

isMinus in interface IJoinNode

getAttachedJoinFilters

public final List<FilterNode> getAttachedJoinFilters()

Description copied from interface: IJoinNode

Return the FILTER(s) associated with this IJoinNode. Such filters will be run with the JOIN for this statement pattern. As such, they MUST NOT rely on materialization of variables which would not have been bound before that JOIN.

Specified by:

getAttachedJoinFilters in interface IJoinNode

Returns:

The attached join filters and never null (it may return an empty list)(.

See Also:

ASTSimpleOptionalOptimizer, ASTAttachJoinFiltersOptimizer

setAttachedJoinFilters

public final void setAttachedJoinFilters(List<FilterNode> filters)

Specified by:

setAttachedJoinFilters in interface IJoinNode

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:

getRequiredBound

public Set<IVariable<?>> getRequiredBound(StaticAnalysis sa)

Description copied from interface: IVariableBindingRequirements

Return the variables used in the node that *must* be bound prior to evaluating the node. For instance, when evaluation a SPARQL 1.1 service and the endpoint is specified through a variable, then this variable must be bound in order to identify the endpoint to which the query is to be sent. By *must* be bound we mean that, if it is possible to bring the variables in a join group in order such that they are bound when executing the construct (e.g., think of a FILTER), then we *must* consider that. However, when the IVariableBindingRequirements#getRequiredBound() interface cannot be satisified, the query may still be valid and return results (for the SPARQL 1.1 service example mentioned above, it may not, for the FILTER it may). The set of these variables must be disjoint from IVariableBindingRequirements#getRequiredUnound().

Specified by:

getRequiredBound in interface IVariableBindingRequirements

Returns:

the set of variables that must be bound prior to evaluation

getDesiredBound

public Set<IVariable<?>> getDesiredBound(StaticAnalysis sa)

Description copied from interface: IVariableBindingRequirements

Get variables that are not required to be bound, but desired in the sense that we want them to be bound when evaluating the construct. In general, the more variables are bound, the better, but this might differ for certain constructs. Should only report variables that are *not* reported through method IVariableBindingRequirements.getRequiredBound(StaticAnalysis).

Specified by:

getDesiredBound in interface IVariableBindingRequirements

Returns:

the set of variables that are desires to be bound, but not required