com.bigdata.relation.rule.eval.pipeline

Class LocalJoinTask

java.lang.Object

com.bigdata.relation.rule.eval.pipeline.JoinTask

com.bigdata.relation.rule.eval.pipeline.LocalJoinTask

All Implemented Interfaces:

Callable<Void>

public class LocalJoinTask
extends JoinTask

JoinTask implementation for a Journal.

Version:

$Id$

Author:

Bryan Thompson

Nested Class Summary

Nested classes/interfaces inherited from class com.bigdata.relation.rule.eval.pipeline.JoinTask

JoinTask.AccessPathTask, JoinTask.BindingSetConsumerTask, JoinTask.ChunkTask, JoinTask.ThreadLocalFactory<T extends IBuffer<E>,E>

Field Summary

Fields

Modifier and Type	Field and Description
protected BlockingBuffer<IBindingSet[]>	syncBuffer The BlockingBuffer whose queue will be drained by the downstream LocalJoinTask -or- null IFF [lastJoin == true].

Fields inherited from class com.bigdata.relation.rule.eval.pipeline.JoinTask

DEBUG, firstCause, halt, INFO, joinNexus, lastJoin, log, masterProxy, masterUUID, orderIndex, partitionId, predicate, relation, requiredVars, rule, tailCount, tailIndex, WARN

Constructor Summary

Constructors

Constructor and Description
LocalJoinTask(IRule rule, IJoinNexus joinNexus, int[] order, int orderIndex, IJoinMaster masterProxy, UUID masterUUID, IAsynchronousIterator<IBindingSet[]> source, IBuffer<ISolution[]> solutionBuffer, IVariable[][] requiredVars)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	cancelSinks() Cancel sink JoinTask(s).
protected void	closeSources() Closes the source specified to the ctor.
protected void	flushAndCloseBuffersAndAwaitSinks() Flush and close all output buffers and await sink JoinTask(s).
protected IBuffer<ISolution[]>	getSolutionBuffer() The buffer on which the last predicate in the evaluation order will write its ISolutions.
protected AbstractUnsynchronizedArrayBuffer<IBindingSet>	newUnsyncOutputBuffer() Note: The target buffer on which the unsynchronized buffer writes depends on whether or not there is a downstream sink for this LocalJoinTask.
protected IBindingSet[]	nextChunk() Return the next chunk of IBindingSets the source JoinTask.
protected void	setSinkFuture(Future<? extends Object> f) Set the future for the downstream join dimension on this join task.

Methods inherited from class com.bigdata.relation.rule.eval.pipeline.JoinTask

call, consumeSources, getTailIndex, halt, logCallError, reportOnce, toString

Methods inherited from class java.lang.Object

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

Field Detail

syncBuffer

protected final BlockingBuffer<IBindingSet[]> syncBuffer

The BlockingBuffer whose queue will be drained by the downstream LocalJoinTask -or- null IFF [lastJoin == true].

Constructor Detail

LocalJoinTask

public LocalJoinTask(IRule rule,
             IJoinNexus joinNexus,
             int[] order,
             int orderIndex,
             IJoinMaster masterProxy,
             UUID masterUUID,
             IAsynchronousIterator<IBindingSet[]> source,
             IBuffer<ISolution[]> solutionBuffer,
             IVariable[][] requiredVars)

Parameters:

rule -

joinNexusFactory -

order -

orderIndex -

masterProxy -

masterUUID -

source -

solutionBuffer -

ruleState -

Method Detail

getSolutionBuffer

protected IBuffer<ISolution[]> getSolutionBuffer()

Description copied from class: JoinTask

The buffer on which the last predicate in the evaluation order will write its ISolutions.

Specified by:

getSolutionBuffer in class JoinTask

Returns:

The buffer.

closeSources

protected void closeSources()

Closes the source specified to the ctor.

newUnsyncOutputBuffer

protected final AbstractUnsynchronizedArrayBuffer<IBindingSet> newUnsyncOutputBuffer()

Note: The target buffer on which the unsynchronized buffer writes depends on whether or not there is a downstream sink for this LocalJoinTask. When this is the JoinTask.lastJoin, the unsynchronized buffer returned by this method will write on the solution buffer. Otherwise it will write on syncBuffer, which is drained by the sink LocalJoinTask.

Specified by:

newUnsyncOutputBuffer in class JoinTask

setSinkFuture

protected final void setSinkFuture(Future<? extends Object> f)

Set the future for the downstream join dimension on this join task. This MUST be done before you begin to execute the downstream join. The sink future is relied on by flushAndCloseBuffersAndAwaitSinks() and cancelSinks(), both of which are executed from JoinTask.call().

Parameters:

f - The future for the downstream join dimension.

Throws:

IllegalStateException - if the future was already set.

IllegalArgumentException - if the argument is null.

flushAndCloseBuffersAndAwaitSinks

protected void flushAndCloseBuffersAndAwaitSinks()
                                          throws InterruptedException,
                                                 ExecutionException

Description copied from class: JoinTask

Flush and close all output buffers and await sink JoinTask(s).

Note: You MUST close the BlockingBuffer from which each sink reads before invoking this method in order for those sinks to terminate. Otherwise the source IAsynchronousIterator(s) on which the sink is reading will remain open and the sink will never decide that it has exhausted its source(s).

Specified by:

flushAndCloseBuffersAndAwaitSinks in class JoinTask

Throws:

InterruptedException

ExecutionException

cancelSinks

protected void cancelSinks()

Description copied from class: JoinTask

Cancel sink JoinTask(s).

Specified by:

cancelSinks in class JoinTask

nextChunk

protected IBindingSet[] nextChunk()
                           throws InterruptedException

Return the next chunk of IBindingSets the source JoinTask.

Specified by:

nextChunk in class JoinTask

Returns:

The next chunk -or- null iff the source is exhausted.

Throws:

InterruptedException