org.eclipse.ocl.pivot.internal.library.executor

Class ExecutorSingleIterationManager

java.lang.Object

org.eclipse.ocl.pivot.library.AbstractIterationManager

org.eclipse.ocl.pivot.internal.library.executor.ExecutorSingleIterationManager

All Implemented Interfaces:

IterationManager, IterationManager.IterationManagerExtension

public class ExecutorSingleIterationManager
extends AbstractIterationManager

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.ocl.pivot.evaluation.IterationManager

IterationManager.IterationManagerExtension

Constructor Summary

Constructors

Constructor and Description
ExecutorSingleIterationManager(Evaluator evaluator, TypeId returnTypeId, LibraryBinaryOperation body, CollectionValue collectionValue, Object accumulatorValue) Deprecated. use Executor
ExecutorSingleIterationManager(Executor executor, TypeId returnTypeId, LibraryBinaryOperation body, CollectionValue collectionValue, Object accumulatorValue)

Method Summary

Modifier and Type	Method and Description
boolean	advanceIterators() Advance the iterators to the next iteration, returning false once all possible iterator states have been exhausted.
IterationManager	createNestedIterationManager(CollectionValue value) Create a nested iteration supervisor.
Object	evaluateBody() Evaluate the iteration body for the current iterators and return the evaluation result.
Object	get() Get the current state of the iterator.
Object	getAccumulatorValue() Get the current state of the accumulator.
int	getDepth()
ExecutorSingleIterationManager	getRootIterationManager()
CollectionValue	getSourceCollection() Return the source collection over which this (nested) iteration iterates.
boolean	hasCurrent() Return true if the iterators have a step to be evaluated.
Object	updateAccumulator(Object newValue) Update the accumulator with the result of a body iteration.

Methods inherited from class org.eclipse.ocl.pivot.library.AbstractIterationManager

dispose, getEvaluator, getExecutor, getStandardLibrary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExecutorSingleIterationManager

@Deprecated
public ExecutorSingleIterationManager(Evaluator evaluator,
                                                  TypeId returnTypeId,
                                                  LibraryBinaryOperation body,
                                                  CollectionValue collectionValue,
                                                  Object accumulatorValue)

Deprecated. use Executor

ExecutorSingleIterationManager

public ExecutorSingleIterationManager(Executor executor,
                                      TypeId returnTypeId,
                                      LibraryBinaryOperation body,
                                      CollectionValue collectionValue,
                                      Object accumulatorValue)

Since:

1.1

Method Detail

advanceIterators

public boolean advanceIterators()

Description copied from interface: IterationManager

Advance the iterators to the next iteration, returning false once all possible iterator states have been exhausted.

createNestedIterationManager

public IterationManager createNestedIterationManager(CollectionValue value)

Description copied from interface: IterationManager

Create a nested iteration supervisor.
This method supports the closure iteration for which there is only a single iterator, and so this method need only be supported by single iterator managers.

Specified by:

createNestedIterationManager in interface IterationManager

Overrides:

createNestedIterationManager in class AbstractIterationManager

Parameters:

value - the nested iteration domain

Returns:

the iteration space

evaluateBody

public Object evaluateBody()

Description copied from interface: IterationManager

Evaluate the iteration body for the current iterators and return the evaluation result.
This is used by non-iterate iteration that intervene between the body evaluation and accumulator update.

get

public Object get()

Description copied from interface: IterationManager

Get the current state of the iterator.
This is only supported for single iterator iterations.

Specified by:

get in interface IterationManager

Overrides:

get in class AbstractIterationManager

getAccumulatorValue

public Object getAccumulatorValue()

Description copied from interface: IterationManager

Get the current state of the accumulator.

getDepth

public int getDepth()

getRootIterationManager

public ExecutorSingleIterationManager getRootIterationManager()

getSourceCollection

public CollectionValue getSourceCollection()

Description copied from interface: IterationManager

Return the source collection over which this (nested) iteration iterates.

hasCurrent

public boolean hasCurrent()

Description copied from interface: IterationManager

Return true if the iterators have a step to be evaluated.

updateAccumulator

public Object updateAccumulator(Object newValue)

Description copied from interface: IterationManager

Update the accumulator with the result of a body iteration.
This implements the body of an iterate iteration for which the accumulator value may be assigned to a completely independent value. Returns null for the iteration to continue, non-null to terminate.