com.bigdata.rdf.sparql.ast

Class BindingsClause

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

com.bigdata.rdf.sparql.ast.BindingsClause

All Implemented Interfaces:

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

public class BindingsClause
extends GroupMemberNodeBase<BindingsClause>
implements IBindingProducerNode, IJoinNode, IReorderableNode

The solutions declared by a BINDINGS clause.

Version:

$Id$

Author:

Bryan Thompson

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BindingsClause.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
BindingsClause(BindingsClause bindings) Deep copy constructor.
BindingsClause(BOp[] args, Map<String,Object> anns)
BindingsClause(LinkedHashSet<IVariable<?>> declaredVars, List<IBindingSet> bindingSets)

Method Summary

Methods

Modifier and Type	Method and Description
List<FilterNode>	getAttachedJoinFilters() Return the FILTER(s) associated with this IJoinNode.
List<IBindingSet>	getBindingSets() The binding sets -or- null.
int	getBindingSetsCount() Return the #of binding sets.
int	getDeclaredVariableCount() Return the #of declared variables.
LinkedHashSet<IVariable<?>>	getDeclaredVariables() Return the ordered set of declared variables for the BINDINGS clause.
LinkedHashSet<IVariable<?>>	getDefinitelyProducedBindings() Return the ordered set of variables that will definitely be bound by this bindings/values clause.
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.
long	getEstimatedCardinality(StaticOptimizer opt) Return the estimated cardinality - either the range count of a statement pattern or some computed estimated cardinality for a join group.
Set<IVariable<?>>	getRequiredBound(StaticAnalysis sa) Return the variables used in the node that *must* be bound prior to evaluating the node.
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	isReorderable() The decision about whether to re-order can no longer be made simply by examining the type - individual instances of a particular type may or may not be reorderable.
void	setAttachedJoinFilters(List<FilterNode> filters)
void	setBindingSets(List<IBindingSet> bindingSets)
void	setDeclaredVariables(LinkedHashSet<IVariable<?>> declaredVars)
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.rdf.sparql.ast.IGroupMemberNode

getContext, getParent, getParentGraphPatternGroup, getParentJoinGroup, setParent

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

BindingsClause

public BindingsClause(BindingsClause bindings)

Deep copy constructor.

Parameters:

bindings -

BindingsClause

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

BindingsClause

public BindingsClause(LinkedHashSet<IVariable<?>> declaredVars,
              List<IBindingSet> bindingSets)

Parameters:

declaredVars - The ordered set of declared variables.

bindingSets - The set of solutions.

Method Detail

getDeclaredVariableCount

public final int getDeclaredVariableCount()

Return the #of declared variables.

getDeclaredVariables

public final LinkedHashSet<IVariable<?>> getDeclaredVariables()

Return the ordered set of declared variables for the BINDINGS clause. The declared variables MIGHT have a binding in any given solution, but there is no guarantee that any given variable is ever bound within a solution.

setDeclaredVariables

public final void setDeclaredVariables(LinkedHashSet<IVariable<?>> declaredVars)

getDefinitelyProducedBindings

public final LinkedHashSet<IVariable<?>> getDefinitelyProducedBindings()

Return the ordered set of variables that will definitely be bound by this bindings/values clause.

getBindingSetsCount

public final int getBindingSetsCount()

Return the #of binding sets.

getBindingSets

public final List<IBindingSet> getBindingSets()

The binding sets -or- null.

setBindingSets

public final void setBindingSets(List<IBindingSet> bindingSets)

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:

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

isOptional

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

Specified by:

isOptional in interface IJoinNode

isMinus

public boolean isMinus()

Description copied from interface: IJoinNode

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

Specified by:

isMinus in interface IJoinNode

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

isReorderable

public boolean isReorderable()

Description copied from interface: IReorderableNode

The decision about whether to re-order can no longer be made simply by examining the type - individual instances of a particular type may or may not be reorderable.

Specified by:

isReorderable in interface IReorderableNode

getEstimatedCardinality

public long getEstimatedCardinality(StaticOptimizer opt)

Description copied from interface: IReorderableNode

Return the estimated cardinality - either the range count of a statement pattern or some computed estimated cardinality for a join group.

Specified by:

getEstimatedCardinality in interface IReorderableNode

Parameters:

opt - This optimizer can be used to help work out the estimate