com.bigdata.rdf.sparql.ast

Class JoinGroupNode

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<E>

com.bigdata.rdf.sparql.ast.GroupNodeBase<E>

com.bigdata.rdf.sparql.ast.GraphPatternGroup<IGroupMemberNode>

com.bigdata.rdf.sparql.ast.JoinGroupNode

All Implemented Interfaces:

BOp, IBindingProducerNode, IGroupMemberNode, IGroupNode<IGroupMemberNode>, IJoinNode, IQueryNode, IVariableBindingRequirements, IPropertySet, Serializable, Cloneable, Iterable<IGroupMemberNode>

public class JoinGroupNode
extends GraphPatternGroup<IGroupMemberNode>

An optional or non-optional collection of query nodes that run together in a group.

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
JoinGroupNode() Construct a non-optional join group.
JoinGroupNode(boolean optional)
JoinGroupNode(boolean optional, IGroupMemberNode child) Construct a possibly optional group having the specified child as its initial member.
JoinGroupNode(BOp[] args, Map<String,Object> anns) Required shallow copy constructor.
JoinGroupNode(IGroupMemberNode child) Construct a non-optional join group having the specified child as its initial member.
JoinGroupNode(JoinGroupNode op) Constructor required for com.bigdata.bop.BOpUtility#deepCopy(FilterNode).
JoinGroupNode(TermNode context, IGroupMemberNode child) Construct a GRAPH group having the specified child as its initial member.

Method Summary

Methods

Modifier and Type	Method and Description
List<FilterNode>	getAllFiltersInGroup() Return only the filter child nodes in this group.
List<AssignmentNode>	getAssignments() Return any LET x:= expr or (expr AS ?x) nodes in this group (these are modeled in exactly the same way by the AST AssignmentNode).
TermNode	getContext() Return the context for the group graph pattern dominating this node.
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.
List<FilterNode>	getInFilters() Return the set of IN filters for this group.
List<NamedSubqueryInclude>	getNamedSubqueryIncludes() Return only the NamedSubqueryInclude child nodes in this group.
QueryOptimizerEnum	getQueryOptimizer() Return the QueryOptimizerEnum that is in effect for this JoinGroupNode.
List<IReorderableNode>	getReorderableChildren()
Set<IVariable<?>>	getRequiredBound(StaticAnalysis sa) Return the variables used in the node that *must* be bound prior to evaluating the node.
int	getRequiredStatementPatternCount() Return the #of required statement patterns (does not include those flagged as OPTIONAL).
List<ServiceNode>	getServiceNodes() Return only the ServiceNode child nodes in this group.
int	getStatementPatternCount() Return the #of statement patterns.
List<StatementPatternNode>	getStatementPatterns() Return only the statement pattern child nodes in this group.
boolean	isMinus() Return true iff this is a join group representing a SPARQL MINUS operator.
boolean	isOptional() Return whether or not this is an join with "optional" semantics.
boolean	isSubgroupOfALPNode() Returns the property Annotations#IS_SUBGROUP_OF_ALP_NODE of this JoinGroupNode.
void	setContext(TermNode context) Set the context for a GroupGraphPattern.
void	setMinus(boolean minus)
void	setOptional(boolean optional)
void	setSubgroupOfALPNode(boolean isSubgroup)

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

getChildren, getJoinVars, getProjectInVars, setJoinVars, setProjectInVars

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

addArg, addArg, addChild, clone, getAttachedJoinFilters, getChildren, isEmpty, iterator, removeArg, removeChild, replaceWith, setArg, setAttachedJoinFilters, size, toString

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

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

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

Methods inherited from class com.bigdata.bop.CoreBaseBOp

annotationsEqual, annotationsToString, annotationsToString, annotationValueToString, checkArgs, 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.rdf.sparql.ast.IJoinNode

getAttachedJoinFilters, setAttachedJoinFilters

Methods inherited from interface com.bigdata.rdf.sparql.ast.IQueryNode

toString

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

Methods inherited from interface com.bigdata.rdf.sparql.ast.IGroupMemberNode

getParent, getParentGraphPatternGroup, getParentJoinGroup, setParent

Constructor Detail

JoinGroupNode

public JoinGroupNode(JoinGroupNode op)

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

Note: There is a nasty potential for a conflict here. This constructor is part of the deep copy semantics. The JoinGroupNode(IGroupMemberNode child) This means that the following code DOES NOT create a nested structure of a JoinGroupNode in a JoinGroupNode.

 new JoinGroupNode(new JoinGroupNode); // COPY CONSTRUCTOR PATTERN.
 

Instead you MUST do this incrementally

 final JoinGroupNode parent = new JoinGroupNode();
 parent.addChild(new JoinGroupNode());
 

and if you need to add things to the child, then the pattern becomes:

 final JoinGroupNode parent = new JoinGroupNode();
 final JoinGroupNode child1 = new JoinGroupNode()
 parent.addChild(child1);
 child1.addChild(...);
 

JoinGroupNode

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

Required shallow copy constructor.

JoinGroupNode

public JoinGroupNode()

Construct a non-optional join group.

JoinGroupNode

public JoinGroupNode(IGroupMemberNode child)

Construct a non-optional join group having the specified child as its initial member.

JoinGroupNode

public JoinGroupNode(boolean optional)

JoinGroupNode

public JoinGroupNode(boolean optional,
             IGroupMemberNode child)

Construct a possibly optional group having the specified child as its initial member.

Parameters:

optional - true iff the group is optional.

child - The initial child.

JoinGroupNode

public JoinGroupNode(TermNode context,
             IGroupMemberNode child)

Construct a GRAPH group having the specified child as its initial member.

Parameters:

context - The variable or constant for the GRAPH group.

child - The initial child.

Method Detail

setContext

public void setContext(TermNode context)

Set the context for a GroupGraphPattern.

Parameters:

context - The context (may be null).

getContext

public TermNode getContext()

Return the context for the group graph pattern dominating this node.

Overridden to return the context associated with this JoinGroupNode if it is defined and otherwise read up the parent chain.

Specified by:

getContext in interface IGroupMemberNode

Overrides:

getContext in class GroupMemberNodeBase<IGroupMemberNode>

Returns:

The context -or- null if there is no graph pattern dominating this node.

isOptional

public final boolean isOptional()

Description copied from interface: IJoinNode

Return whether or not this is an join with "optional" semantics. Optional joins may or may not produce variable bindings, but will not reduce the incoming solutions based on whether or not they bind.

setOptional

public final void setOptional(boolean optional)

isMinus

public final boolean isMinus()

Description copied from interface: IJoinNode

Return true iff this is a join group representing a SPARQL MINUS operator.

setMinus

public void setMinus(boolean minus)

isSubgroupOfALPNode

public final boolean isSubgroupOfALPNode()

Returns the property Annotations#IS_SUBGROUP_OF_ALP_NODE of this JoinGroupNode.

setSubgroupOfALPNode

public final void setSubgroupOfALPNode(boolean isSubgroup)

getQueryOptimizer

public final QueryOptimizerEnum getQueryOptimizer()

Return the QueryOptimizerEnum that is in effect for this JoinGroupNode. This will be the value specified through QueryHints.OPTIMIZER and otherwise the default value given by QueryHints.DEFAULT_OPTIMIZER.

Returns:

The effective query optimizer for this join group.

getStatementPatterns

public List<StatementPatternNode> getStatementPatterns()

Return only the statement pattern child nodes in this group.

getStatementPatternCount

public int getStatementPatternCount()

Return the #of statement patterns.

getRequiredStatementPatternCount

public int getRequiredStatementPatternCount()

Return the #of required statement patterns (does not include those flagged as OPTIONAL).

getServiceNodes

public List<ServiceNode> getServiceNodes()

Return only the ServiceNode child nodes in this group.

getNamedSubqueryIncludes

public List<NamedSubqueryInclude> getNamedSubqueryIncludes()

Return only the NamedSubqueryInclude child nodes in this group.

getAssignments

public List<AssignmentNode> getAssignments()

Return any LET x:= expr or (expr AS ?x) nodes in this group (these are modeled in exactly the same way by the AST AssignmentNode).

Note: AssignmentNodes MUST NOT be reordered. They MUST be evaluated left-to-right in the order given in the original query.

getAllFiltersInGroup

public List<FilterNode> getAllFiltersInGroup()

Return only the filter child nodes in this group.

getInFilters

public List<FilterNode> getInFilters()

Return the set of IN filters for this group. FIXME We need to move away from the DataSetJoin class and replace it with an IPredicate to which we have attached an inline access path. That transformation needs to happen in a rewrite rule, which means that we will wind up removing the IN filter and replacing it with an AST node for that inline AP (something conceptually similar to a statement pattern but for a column projection of the variable for the IN expression). That way we do not have to magically "subtract" the known "IN" filters out of the join- and post- filters.

See Also:

(Replace DataSetJoin with an "inline" access path.)

getReorderableChildren

public List<IReorderableNode> getReorderableChildren()

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().

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).

Returns:

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