com.bigdata.bop.join

Class HTreePipelinedHashJoinUtility

java.lang.Object

com.bigdata.bop.join.HTreeHashJoinUtility

com.bigdata.bop.join.HTreePipelinedHashJoinUtility

All Implemented Interfaces:

IHashJoinUtility, PipelinedHashJoinUtility

public class HTreePipelinedHashJoinUtility
extends HTreeHashJoinUtility
implements PipelinedHashJoinUtility

Utility class supporting a pipelined hash join. This is a variant of the HTreeHashJoinUtility. See PipelinedHashIndexAndSolutionSetJoinOp for a documentation of this functionality.

Version:

$Id$

Author:

Michael Schmidt

Nested Class Summary

Nested classes/interfaces inherited from class com.bigdata.bop.join.HTreeHashJoinUtility

HTreeHashJoinUtility.BS

Field Summary

Fields

Modifier and Type	Field and Description
static IHashJoinUtilityFactory	factory Singleton IHashJoinUtilityFactory that can be used to create a new HTreePipelinedHashJoinUtility.
protected CAT	nDistinctBindingSets The #of distinct projections from the given input bindings
protected CAT	nDistinctBindingSetsReleased The #of distinct binding sets that have flown into the subquery.
protected CAT	nResultsFromSubqueries The #of results returned by the subqueries
protected CAT	nSubqueriesIssued The #of subqueries that have been issued.

Fields inherited from class com.bigdata.bop.join.HTreeHashJoinUtility

nJoinsConsidered, nleftConsidered, nrightConsidered

Constructor Summary

Constructors

Constructor and Description
HTreePipelinedHashJoinUtility(IMemoryManager mmgr, PipelineOp op, JoinTypeEnum joinType)
HTreePipelinedHashJoinUtility(PipelineOp op, JoinTypeEnum joinType, BOpContext<IBindingSet> context, int chunkCapacity)

Method Summary

Methods

Modifier and Type	Method and Description
long	acceptAndOutputSolutions(UnsyncLocalOutputBuffer<IBindingSet> out, ICloseableIterator<IBindingSet[]> itr, NamedSolutionSetStats stats, IConstraint[] joinConstraints, PipelineOp subquery, IBindingSet[] bsFromBindingsSetSource, IVariable<?>[] projectInVars, IVariable<?> askVar, boolean isLastInvocation, int distinctProjectionBufferThreshold, int incomingBindingsBufferThreshold, BOpContext<IBindingSet> context) AcceptAndOutputSolutions is a special method for building the hash index of the JVMPipelinedHashIndex, which accepts and immediately forwards relevant solutions (non-blocking index).
void	hashJoinAndEmit(IBindingSet[] chunk, BOpStats stats, IBuffer<IBindingSet> outputBuffer, IConstraint[] joinConstraints, IVariable<?> askVar) Executes the hash join for the chunk of solutions that is passed in over rightSolutions and outputs the solutions.
protected boolean	joinsWith(HTreeHashJoinUtility.BS bs, IKeyBuilder keyBuilder, HTree htree) Checks whether bs joins with the given htree.
protected boolean	joinsWith(HTreeHashJoinUtility.BS bs, IKeyBuilder keyBuilder, HTree rightSolutions, HTree rightSolutionsWithoutSubqueryResult) Checks whether bs joins with rightSolutions or rightSolutionsWithoutSubqueryResult.
protected RuntimeException	launderThrowable(Throwable t) Adds metadata about the IHashJoinUtility state to the stack trace.
String	toString() Human readable representation of the IHashJoinUtility metadata (but not the solutions themselves).

Methods inherited from class com.bigdata.bop.join.HTreeHashJoinUtility

acceptSolutions, decodeSolution, filterSolutions, getAskVar, getConstraints, getEncoder, getIndexMetadata, getJoinSet, getJoinSetSize, getJoinType, getJoinVars, getNoJoinVarsLimit, getOpen, getOutputDistintcJVs, getRightSolutionCount, getRightSolutions, getSelectVars, getStore, hashJoin, hashJoin2, indexScan, isEmpty, isOutputDistinctJoinVars, mergeJoin, outputJoinSet, outputOptionals, outputSolutions, release, saveInJoinSet, saveSolutionSet, vector

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

nDistinctBindingSets

protected final CAT nDistinctBindingSets

The #of distinct projections from the given input bindings

nDistinctBindingSetsReleased

protected final CAT nDistinctBindingSetsReleased

The #of distinct binding sets that have flown into the subquery.

nSubqueriesIssued

protected final CAT nSubqueriesIssued

The #of subqueries that have been issued.

nResultsFromSubqueries

protected final CAT nResultsFromSubqueries

The #of results returned by the subqueries

factory

public static final IHashJoinUtilityFactory factory

Singleton IHashJoinUtilityFactory that can be used to create a new HTreePipelinedHashJoinUtility.

Constructor Detail

HTreePipelinedHashJoinUtility

public HTreePipelinedHashJoinUtility(IMemoryManager mmgr,
                             PipelineOp op,
                             JoinTypeEnum joinType)

HTreePipelinedHashJoinUtility

public HTreePipelinedHashJoinUtility(PipelineOp op,
                             JoinTypeEnum joinType,
                             BOpContext<IBindingSet> context,
                             int chunkCapacity)

Method Detail

acceptAndOutputSolutions

public long acceptAndOutputSolutions(UnsyncLocalOutputBuffer<IBindingSet> out,
                            ICloseableIterator<IBindingSet[]> itr,
                            NamedSolutionSetStats stats,
                            IConstraint[] joinConstraints,
                            PipelineOp subquery,
                            IBindingSet[] bsFromBindingsSetSource,
                            IVariable<?>[] projectInVars,
                            IVariable<?> askVar,
                            boolean isLastInvocation,
                            int distinctProjectionBufferThreshold,
                            int incomingBindingsBufferThreshold,
                            BOpContext<IBindingSet> context)

Description copied from interface: PipelinedHashJoinUtility

AcceptAndOutputSolutions is a special method for building the hash index of the JVMPipelinedHashIndex, which accepts and immediately forwards relevant solutions (non-blocking index).

Specified by:

acceptAndOutputSolutions in interface PipelinedHashJoinUtility

joinsWith

protected boolean joinsWith(HTreeHashJoinUtility.BS bs,
                IKeyBuilder keyBuilder,
                HTree rightSolutions,
                HTree rightSolutionsWithoutSubqueryResult)

Checks whether bs joins with rightSolutions or rightSolutionsWithoutSubqueryResult. Returns false if and only if joins neither with the one nor with the other.

Parameters:

bs -

keyBuilder -

rightSolutions -

rightSolutionsWithoutSubqueryResult -

Returns:

joinsWith

protected boolean joinsWith(HTreeHashJoinUtility.BS bs,
                IKeyBuilder keyBuilder,
                HTree htree)

Checks whether bs joins with the given htree.

Parameters:

bs -

keyBuilder -

htree -

Returns:

hashJoinAndEmit

public void hashJoinAndEmit(IBindingSet[] chunk,
                   BOpStats stats,
                   IBuffer<IBindingSet> outputBuffer,
                   IConstraint[] joinConstraints,
                   IVariable<?> askVar)

Executes the hash join for the chunk of solutions that is passed in over rightSolutions and outputs the solutions.

launderThrowable

protected RuntimeException launderThrowable(Throwable t)

Adds metadata about the IHashJoinUtility state to the stack trace.

Parameters:

t - The thrown error.

Returns:

The laundered exception.

Throws:

Exception

toString

public String toString()

Human readable representation of the IHashJoinUtility metadata (but not the solutions themselves).

Overrides:

toString in class HTreeHashJoinUtility