org.eclipse.ocl.pivot.evaluation

Interface IterationManager

All Known Subinterfaces:

IterationManager.IterationManagerExtension, IterationManager.IterationManagerExtension2

All Known Implementing Classes:

AbstractEvaluatorIterableIterationManager, AbstractEvaluatorIterationManager, AbstractIterationManager, EvaluatorMultipleIterationManager, EvaluatorMultipleMapIterationManager, EvaluatorSingleIterationManager, EvaluatorSingleMapIterationManager, ExecutorDoubleIterationManager, ExecutorMultipleIterationManager, ExecutorMultipleMapIterationManager, ExecutorSingleIterationManager, ExecutorSingleMapIterationManager

public interface IterationManager

IterationManager defines the supervisor for an iteration. It provides a body, one or more iterators and an accumulator, which may be updated by evaluating the body.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IterationManager.IterationManagerExtension
static interface	IterationManager.IterationManagerExtension2

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) Deprecated. use IterationManagerExtension2 and IterableValue
void	dispose()
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.
Evaluator	getEvaluator() Deprecated. use getExecutor()
CollectionValue	getSourceCollection() Deprecated. replaced by getSourceIterable
StandardLibrary	getStandardLibrary()
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.

Method Detail

advanceIterators

boolean advanceIterators()

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

createNestedIterationManager

@Deprecated
IterationManager createNestedIterationManager(CollectionValue value)

Deprecated. use IterationManagerExtension2 and IterableValue

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.

Parameters:

value - the nested iteration domain

Returns:

the iteration space

Throws:

InvalidValueException

dispose

void dispose()

evaluateBody

Object evaluateBody()

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

Object get()

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

getAccumulatorValue

Object getAccumulatorValue()

Get the current state of the accumulator.

getEvaluator

@Deprecated
Evaluator getEvaluator()

Deprecated. use getExecutor()

getSourceCollection

@Deprecated
CollectionValue getSourceCollection()

Deprecated. replaced by getSourceIterable

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

getStandardLibrary

StandardLibrary getStandardLibrary()

hasCurrent

boolean hasCurrent()

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

updateAccumulator

Object updateAccumulator(Object newValue)

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.

Throws:

InvalidValueException