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, 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: NamedSubqueryInclude.java 6290 2012-04-15 12:15:06Z thompsonbry $

Author:

Bryan Thompson

See Also:

NamedSubqueryRoot, Serialized Form

Nested Class Summary

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

NamedSubqueryInclude(BOp[] args, Map<String,Object> anns)
Required shallow copy constructor.

NamedSubqueryInclude(NamedSubqueryInclude op)
Required deep copy constructor.

NamedSubqueryInclude(String name)

Method Summary

List<FilterNode>	getAttachedJoinFilters() Return the FILTER(s) associated with this IJoinNode.
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.
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) Pretty print with an indent.

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

toString

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

getQueryHint, getQueryHint, getQueryHintAsBoolean, getQueryHintAsBoolean, getQueryHints, replaceAllWith, setQueryHint, setQueryHints

Methods inherited from class com.bigdata.bop.ModifiableBOpBase

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

Methods inherited from class com.bigdata.bop.CoreBaseBOp

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

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedSubqueryInclude

public NamedSubqueryInclude(NamedSubqueryInclude op)

Required deep copy constructor.

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 interface: IQueryNode

Pretty print with an indent.

Specified by:

toString in interface IQueryNode