Class JoinExecutorBase<T>

java.lang.Object

org.eclipse.rdf4j.common.iteration.AbstractCloseableIteration<T>

org.eclipse.rdf4j.common.iteration.LookAheadIteration<T>

org.eclipse.rdf4j.federated.evaluation.concurrent.ParallelExecutorBase<T>

org.eclipse.rdf4j.federated.evaluation.join.JoinExecutorBase<T>

All Implemented Interfaces:

AutoCloseable, Runnable, Iterator<T>, CloseableIteration<T>, ParallelExecutor<T>

Direct Known Subclasses:

ControlledWorkerBindJoinBase, ControlledWorkerJoin, ControlledWorkerLeftJoin

public abstract class JoinExecutorBase<T>
extends ParallelExecutorBase<T>

Base class for any join parallel join executor. Note that this class extends LookAheadIteration and thus any implementation of this class is applicable for pipelining when used in a different thread (access to shared variables is synchronized).

Author:

Andreas Schwarte

Field Summary

Fields

Modifier and Type	Field	Description
protected final BindingSet	bindings
protected Set<String>	joinVars
protected CloseableIteration<T>	leftIter
protected final TupleExpr	rightArg

Fields inherited from class ParallelExecutorBase

evaluationThread, executorId, finished, log, NEXT_EXECUTOR_ID, queryInfo, rightIter, rightQueue, strategy

Modifier and Type	Field	Description
protected Thread	evaluationThread
protected final long	executorId
protected boolean	finished
protected static final org.slf4j.Logger	log
protected static final AtomicLong	NEXT_EXECUTOR_ID
protected final QueryInfo	queryInfo
protected CloseableIteration<T>	rightIter
protected FedXQueueCursor<T>	rightQueue
protected final FederationEvaluationStrategy	strategy

Fields inherited from interface CloseableIteration

EMPTY_STATEMENT_ITERATION

Modifier and Type	Field	Description
static final EmptyIteration<Statement>	EMPTY_STATEMENT_ITERATION

Constructor Summary

Constructors

Constructor	Description
JoinExecutorBase(FederationEvaluationStrategy strategy, CloseableIteration<T> leftIter, TupleExpr rightArg, BindingSet bindings, QueryInfo queryInfo)

Method Summary

Modifier and Type	Method	Description
protected String	getExecutorType()
Set<String>	getJoinVars()
protected abstract void	handleBindings()	Implementations must implement this method to handle bindings.
void	handleClose()	Called by AbstractCloseableIteration.close() when it is called for the first time.
protected final void	performExecution()	Perform the parallel execution.
void	setJoinVars(Set<String> joinVars)	Set the join variables

Methods inherited from class ParallelExecutorBase

addResult, checkTimeout, done, getDisplayId, getId, getNextElement, getQueryInfo, isFinished, run, toss, toString

Modifier and Type	Method	Description
void	addResult(CloseableIteration<T> res)	Handle the result appropriately, e.g. add it to the result iteration.
protected void	checkTimeout()	Checks whether the query execution has run into a timeout.
void	done()	Inform the controlling instance that some job is done from a different thread.
String	getDisplayId()
protected String	getId()
T	getNextElement()	Gets the next element.
QueryInfo	getQueryInfo()	Return the query info of the associated query
boolean	isFinished()	Return true if this executor is finished or aborted
final void	run()
void	toss(Exception e)	Toss some exception to the controlling instance
String	toString()

Methods inherited from class LookAheadIteration

hasNext, next, remove

Modifier and Type	Method	Description
final boolean	hasNext()
final T	next()
void	remove()	Throws an UnsupportedOperationException.

Methods inherited from class AbstractCloseableIteration

close, isClosed

Modifier and Type	Method	Description
final void	close()	Calls AbstractCloseableIteration.handleClose() upon first call and makes sure the resource closures are only executed once.
final boolean	isClosed()	Checks whether this CloseableIteration has been closed.

Methods inherited from class Object

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

Methods inherited from interface CloseableIteration

stream

Modifier and Type	Method	Description
default Stream<T>	stream()	Convert the results to a Java 8 Stream.

Methods inherited from interface Iterator

forEachRemaining

Field Details

rightArg

protected final TupleExpr rightArg

bindings

protected final BindingSet bindings

joinVars

protected Set<String> joinVars

leftIter

protected CloseableIteration<T> leftIter

Constructor Details

JoinExecutorBase

public JoinExecutorBase(FederationEvaluationStrategy strategy,
 CloseableIteration<T> leftIter,
 TupleExpr rightArg,
 BindingSet bindings,
 QueryInfo queryInfo)
                 throws QueryEvaluationException

Throws:

QueryEvaluationException

Method Details

performExecution

protected final void performExecution()
                               throws Exception

Description copied from class: ParallelExecutorBase

Perform the parallel execution.

Note that this method must block until the execution is completed.

Specified by:

performExecution in class ParallelExecutorBase<T>

Throws:

Exception

handleBindings

protected abstract void handleBindings()
                                throws Exception

Implementations must implement this method to handle bindings. Use the following as a template while (!closed invalid input: '&'invalid input: '&' leftIter.hasNext()) { // your code } and add results to rightQueue. Note that addResult() is implemented synchronized and thus thread safe. In case you can guarantee sequential access, it is also possible to directly access rightQueue Note that the implementation must block until the entire join is executed.

Throws:

Exception

handleClose

public void handleClose()
                 throws QueryEvaluationException

Description copied from class: AbstractCloseableIteration

Called by AbstractCloseableIteration.close() when it is called for the first time. This method is only called once on each iteration. By default, this method does nothing.

Overrides:

handleClose in class ParallelExecutorBase<T>

Throws:

QueryEvaluationException

getExecutorType

protected String getExecutorType()

Overrides:

getExecutorType in class ParallelExecutorBase<T>

Returns:

the executor type, e.g. "Join". Default "Executor"

getJoinVars

public Set<String> getJoinVars()

Returns:

the join variables, might be null if unknown in the concrete implementation

setJoinVars

public void setJoinVars(Set<String> joinVars)

Set the join variables

Parameters:

joinVars - the join variables