com.bigdata.bop.bset

Class ConditionalRoutingOp

java.lang.Object

com.bigdata.bop.CoreBaseBOp

com.bigdata.bop.BOpBase

com.bigdata.bop.PipelineOp

com.bigdata.bop.bset.ConditionalRoutingOp

All Implemented Interfaces:

BOp, IPropertySet, Serializable, Cloneable

public class ConditionalRoutingOp
extends PipelineOp

An operator for conditional routing of binding sets in a pipeline. The operator will copy binding sets either to the default sink (if a condition is satisfied) and otherwise to the alternate sink (iff one is specified). If a solution fails the constraint and the alternate sink is not specified, then the solution is dropped.

Conditional routing can be useful where a different data flow is required based on the type of an object (for example a term identifier versus an inline term in the RDF database) or where there is a need to jump around a join group based on some condition.

Conditional routing will cause reordering of solutions when the alternate sink is specified as some solutions will flow to the primary sink while others flow to the alterate sink.

Version:

$Id: ConditionalRoutingOp.java 7773 2014-01-11 12:49:05Z thompsonbry $

Author:

Bryan Thompson

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConditionalRoutingOp.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
ConditionalRoutingOp(BOp[] args, Map<String,Object> annotations) Shallow copy constructor.
ConditionalRoutingOp(BOp[] args, NV... anns)
ConditionalRoutingOp(ConditionalRoutingOp op) Deep copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
FutureTask<Void>	eval(BOpContext<IBindingSet> context) Return a FutureTask which computes the operator against the evaluation context.
IConstraint	getCondition()

Methods inherited from class com.bigdata.bop.PipelineOp

assertAtOnceJavaHeapOp, assertMaxParallelOne, getChunkCapacity, getChunkOfChunksCapacity, getChunkTimeout, getMaxMemory, getMaxParallel, isAtOnceEvaluation, isBlockedEvaluation, isLastPassRequested, isPipelinedEvaluation, isReorderSolutions, isSharedState, newStats

Methods inherited from class com.bigdata.bop.BOpBase

__replaceArg, _clearProperty, _set, _setProperty, annotations, annotationsCopy, annotationsEqual, annotationsRef, argIterator, args, argsCopy, arity, clearAnnotations, clearProperty, deepCopy, deepCopy, get, getProperty, setArg, 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, toString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConditionalRoutingOp

public ConditionalRoutingOp(ConditionalRoutingOp op)

Deep copy constructor.

Parameters:

op -

ConditionalRoutingOp

public ConditionalRoutingOp(BOp[] args,
                    Map<String,Object> annotations)

Shallow copy constructor.

Parameters:

args -

annotations -

ConditionalRoutingOp

public ConditionalRoutingOp(BOp[] args,
                    NV... anns)

Method Detail

getCondition

public IConstraint getCondition()

See Also:

ConditionalRoutingOp.Annotations.CONDITION

eval

public FutureTask<Void> eval(BOpContext<IBindingSet> context)

Description copied from class: PipelineOp

Return a FutureTask which computes the operator against the evaluation context. The caller is responsible for executing the FutureTask (this gives them the ability to hook the completion of the computation).

Specified by:

eval in class PipelineOp

Parameters:

context - The evaluation context.

Returns:

The FutureTask which will compute the operator's evaluation.