Package org.apache.wayang.java.operators

Class JavaLoopOperator<InputType,ConvergenceType>

java.lang.Object

org.apache.wayang.core.plan.wayangplan.OperatorBase

org.apache.wayang.basic.operators.LoopOperator<InputType,ConvergenceType>

org.apache.wayang.java.operators.JavaLoopOperator<InputType,ConvergenceType>

All Implemented Interfaces:

java.io.Serializable, ActualOperator, ElementaryOperator, ExecutionOperator, LoopHeadOperator, Operator, JavaExecutionOperator

public class JavaLoopOperator<InputType,ConvergenceType>
extends LoopOperator<InputType,ConvergenceType>
implements JavaExecutionOperator

Java implementation of the LoopOperator.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wayang.core.plan.wayangplan.OperatorBase

OperatorBase.GsonSerializer

Nested classes/interfaces inherited from interface org.apache.wayang.core.plan.wayangplan.LoopHeadOperator

LoopHeadOperator.State

Field Summary

Fields inherited from class org.apache.wayang.basic.operators.LoopOperator

criterionDescriptor, FINAL_OUTPUT_INDEX, INITIAL_CONVERGENCE_INPUT_INDEX, INITIAL_INPUT_INDEX, ITERATION_CONVERGENCE_INPUT_INDEX, ITERATION_CONVERGENCE_OUTPUT_INDEX, ITERATION_INPUT_INDEX, ITERATION_OUTPUT_INDEX

Fields inherited from class org.apache.wayang.core.plan.wayangplan.OperatorBase

inputSlots, outputSlots, STANDARD_OPERATOR_ARGS

Fields inherited from interface org.apache.wayang.core.plan.wayangplan.Operator

FIRST_EPOCH

Constructor Summary

Constructors

Constructor	Description
JavaLoopOperator(LoopOperator<InputType,ConvergenceType> that)	Creates a copy of the given LoopOperator.
JavaLoopOperator(DataSetType<InputType> inputType, DataSetType<ConvergenceType> convergenceType, FunctionDescriptor.SerializablePredicate<java.util.Collection<ConvergenceType>> criterionPredicate, java.lang.Integer numExpectedIterations)	Creates a new instance.
JavaLoopOperator(DataSetType<InputType> inputType, DataSetType<ConvergenceType> convergenceType, PredicateDescriptor<java.util.Collection<ConvergenceType>> criterionDescriptor, java.lang.Integer numExpectedIterations)

Method Summary

Modifier and Type	Method	Description
protected ExecutionOperator	createCopy()
java.util.Optional<LoadProfileEstimator>	createLoadProfileEstimator(Configuration configuration)	Developers of ExecutionOperators can provide a default LoadProfileEstimator via this method.
Tuple<java.util.Collection<ExecutionLineageNode>,java.util.Collection<ChannelInstance>>	evaluate(ChannelInstance[] inputs, ChannelInstance[] outputs, JavaExecutor javaExecutor, OptimizationContext.OperatorContext operatorContext)	Evaluates this operator.
java.lang.String	getLoadProfileEstimatorConfigurationKey()
java.util.List<ChannelDescriptor>	getSupportedInputChannels(int index)	Display the supported Channels for a certain InputSlot.
java.util.List<ChannelDescriptor>	getSupportedOutputChannels(int index)	Display the supported Channels for a certain OutputSlot.

Methods inherited from class org.apache.wayang.basic.operators.LoopOperator

beginIteration, beginIteration, createCardinalityEstimator, endIteration, endIteration, getConditionInputSlots, getConditionOutputSlots, getConvergenceType, getCriterionDescriptor, getFinalLoopOutputs, getForwards, getInputType, getLoopBodyInputs, getLoopBodyOutputs, getLoopInitializationInputs, getNumExpectedIterations, getState, initialize, initialize, isReading, outputConnectTo, outputConnectTo, setNumExpectedIterations, setState

Methods inherited from class org.apache.wayang.core.plan.wayangplan.OperatorBase

accept, addBroadcastInput, addTargetPlatform, at, collectMappedInputSlots, collectMappedOutputSlots, copy, getAllInputs, getAllOutputs, getCardinalityEstimator, getContainer, getEpoch, getName, getOriginal, getSimpleClassName, getTargetPlatforms, isAuxiliary, isSupportingBroadcastInputs, propagateInputCardinality, propagateOutputCardinality, setAuxiliary, setCardinalityEstimator, setContainer, setEpoch, setName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wayang.core.plan.wayangplan.ActualOperator

accept

Methods inherited from interface org.apache.wayang.core.plan.wayangplan.ElementaryOperator

createCardinalityEstimator, getCardinalityEstimator, isAuxiliary, setAuxiliary, setCardinalityEstimator

Methods inherited from interface org.apache.wayang.core.plan.wayangplan.ExecutionOperator

copy, createOutputChannelInstances, getLimitBaseKey, getLoadProfileEstimatorConfigurationKeys, getOriginal, getOutputChannelDescriptor, isFiltered

Methods inherited from interface org.apache.wayang.java.operators.JavaExecutionOperator

getPlatform

Methods inherited from interface org.apache.wayang.core.plan.wayangplan.LoopHeadOperator

getCardinalityPusher, getFinalizationPusher, getInitializationPusher

Methods inherited from interface org.apache.wayang.core.plan.wayangplan.Operator

addBroadcastInput, addTargetPlatform, broadcastTo, broadcastTo, collectMappedInputSlots, collectMappedOutputSlots, connectTo, connectTo, getAllInputs, getAllOutputs, getContainer, getEffectiveOccupant, getEffectiveOccupant, getEpoch, getEstimationContextProperties, getForwards, getInnermostLoop, getInput, getInput, getLoopStack, getName, getNumBroadcastInputs, getNumInputs, getNumOutputs, getNumRegularInputs, getOuterInputSlot, getOutermostInputSlot, getOutermostOutputSlots, getOutput, getOutput, getParent, getTargetPlatforms, isAlternative, isElementary, isExecutionOperator, isFeedbackInput, isFeedforwardOutput, isLoopHead, isLoopSubplan, isOwnerOf, isReading, isSink, isSource, isSubplan, isSupportingBroadcastInputs, isUnconnected, propagateInputCardinality, propagateOutputCardinality, propagateOutputCardinality, setContainer, setEpoch, setInput, setName, setOutput

Constructor Detail

JavaLoopOperator

public JavaLoopOperator(DataSetType<InputType> inputType,
                        DataSetType<ConvergenceType> convergenceType,
                        FunctionDescriptor.SerializablePredicate<java.util.Collection<ConvergenceType>> criterionPredicate,
                        java.lang.Integer numExpectedIterations)

Creates a new instance.

JavaLoopOperator

public JavaLoopOperator(DataSetType<InputType> inputType,
                        DataSetType<ConvergenceType> convergenceType,
                        PredicateDescriptor<java.util.Collection<ConvergenceType>> criterionDescriptor,
                        java.lang.Integer numExpectedIterations)

JavaLoopOperator

public JavaLoopOperator(LoopOperator<InputType,ConvergenceType> that)

Creates a copy of the given LoopOperator.

Parameters:

that - should be copied

Method Detail

evaluate

public Tuple<java.util.Collection<ExecutionLineageNode>,java.util.Collection<ChannelInstance>> evaluate(ChannelInstance[] inputs,
                                                                                                              ChannelInstance[] outputs,
                                                                                                              JavaExecutor javaExecutor,
                                                                                                              OptimizationContext.OperatorContext operatorContext)

Description copied from interface: JavaExecutionOperator

Evaluates this operator. Takes a set of Java Streams according to the operator inputs and produces a set of Streams according to the operator outputs -- unless the operator is a sink, then it triggers execution.

In addition, this method should give feedback of what this instance was doing by wiring the LazyExecutionLineageNodes of input and ouput ChannelInstances and providing a Collection of executed OptimizationContext.OperatorContexts.

Specified by:

evaluate in interface JavaExecutionOperator

Parameters:

inputs - ChannelInstances that satisfy the inputs of this operator

outputs - ChannelInstances that collect the outputs of this operator

javaExecutor - that executes this instance

operatorContext - optimization information for this instance

Returns:

Collections of what has been executed and produced

getLoadProfileEstimatorConfigurationKey

public java.lang.String getLoadProfileEstimatorConfigurationKey()

Specified by:

getLoadProfileEstimatorConfigurationKey in interface ExecutionOperator

createLoadProfileEstimator

public java.util.Optional<LoadProfileEstimator> createLoadProfileEstimator(Configuration configuration)

Description copied from interface: ExecutionOperator

Developers of ExecutionOperators can provide a default LoadProfileEstimator via this method.

Specified by:

createLoadProfileEstimator in interface ExecutionOperator

Parameters:

configuration - in which the LoadProfile should be estimated.

Returns:

an Optional that might contain the LoadProfileEstimator (but Optional.empty() by default)

createCopy

protected ExecutionOperator createCopy()

Overrides:

createCopy in class OperatorBase

getSupportedInputChannels

public java.util.List<ChannelDescriptor> getSupportedInputChannels(int index)

Description copied from interface: ExecutionOperator

Display the supported Channels for a certain InputSlot.

Specified by:

getSupportedInputChannels in interface ExecutionOperator

Parameters:

index - the index of the InputSlot

Returns:

an List of Channels' Classes, ordered by their preference of use

getSupportedOutputChannels

public java.util.List<ChannelDescriptor> getSupportedOutputChannels(int index)

Description copied from interface: ExecutionOperator

Display the supported Channels for a certain OutputSlot.

Specified by:

getSupportedOutputChannels in interface ExecutionOperator

Parameters:

index - the index of the OutputSlot

Returns:

an List of Channels' Classes, ordered by their preference of use

See Also:

ExecutionOperator.getOutputChannelDescriptor(int)