org.eclipse.ocl.pivot.library

Class AbstractEvaluatorIterationManager

java.lang.Object

org.eclipse.ocl.pivot.library.AbstractIterationManager

org.eclipse.ocl.pivot.library.AbstractEvaluatorIterationManager

All Implemented Interfaces:

IterationManager, IterationManager.IterationManagerExtension

Direct Known Subclasses:

EvaluatorMultipleIterationManager, EvaluatorSingleIterationManager

public abstract class AbstractEvaluatorIterationManager
extends AbstractIterationManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractEvaluatorIterationManager.ValueIterator

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

IterationManager.IterationManagerExtension

Field Summary

Fields

Modifier and Type	Field and Description
protected TypedElement	accumulatorVariable
protected OCLExpression	body
protected CallExp	callExp
protected CollectionValue	collectionValue

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

evaluator, executor

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractEvaluatorIterationManager(AbstractEvaluatorIterationManager iterationManager, CollectionValue collectionValue)
	AbstractEvaluatorIterationManager(Evaluator evaluator, OCLExpression body, CollectionValue collectionValue, TypedElement accumulatorVariable, java.lang.Object accumulatorValue) Deprecated.
protected	AbstractEvaluatorIterationManager(Executor executor, CallExp callExp, OCLExpression body, CollectionValue collectionValue, TypedElement accumulatorVariable, java.lang.Object accumulatorValue)

Method Summary

Modifier and Type	Method and Description
protected static AbstractEvaluatorIterationManager.ValueIterator[]	createIterators(TypedElement[] referredIterators, Evaluator evaluator, CollectionValue collectionValue) Deprecated. use Executor
protected static AbstractEvaluatorIterationManager.ValueIterator[]	createIterators(TypedElement[] referredIterators, Executor executor, CollectionValue collectionValue)
void	dispose()
java.lang.Object	evaluateBody() Evaluate the iteration body for the current iterators and return the evaluation result.
java.lang.Object	getAccumulatorValue() Get the current state of the accumulator.
CollectionValue	getCollectionValue()
EvaluationEnvironment	getEvaluationEnvironment()
CollectionValue	getSourceCollection() Return the source collection over which this (nested) iteration iterates.
java.lang.String	toString()
java.lang.Object	updateAccumulator(java.lang.Object newValue) Update the accumulator with the result of a body iteration.

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

createNestedIterationManager, get, getEvaluator, getExecutor, getStandardLibrary

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ocl.pivot.evaluation.IterationManager

advanceIterators, hasCurrent

Field Detail

collectionValue

@NonNull
protected final CollectionValue collectionValue

callExp

protected final CallExp callExp

Since:

1.1

body

@NonNull
protected final OCLExpression body

accumulatorVariable

@Nullable
protected final TypedElement accumulatorVariable

Constructor Detail

AbstractEvaluatorIterationManager

@Deprecated
public AbstractEvaluatorIterationManager(@NonNull
                                                      Evaluator evaluator,
                                                      @NonNull
                                                      OCLExpression body,
                                                      @NonNull
                                                      CollectionValue collectionValue,
                                                      @Nullable
                                                      TypedElement accumulatorVariable,
                                                      @Nullable
                                                      java.lang.Object accumulatorValue)

Deprecated.

deprecated supply a callExp

AbstractEvaluatorIterationManager

protected AbstractEvaluatorIterationManager(@NonNull
                                            Executor executor,
                                            CallExp callExp,
                                            @NonNull
                                            OCLExpression body,
                                            @NonNull
                                            CollectionValue collectionValue,
                                            @Nullable
                                            TypedElement accumulatorVariable,
                                            @Nullable
                                            java.lang.Object accumulatorValue)

Since:

1.1

AbstractEvaluatorIterationManager

public AbstractEvaluatorIterationManager(@NonNull
                                         AbstractEvaluatorIterationManager iterationManager,
                                         @NonNull
                                         CollectionValue collectionValue)

Method Detail

createIterators

@Deprecated
 @NonNull
protected static AbstractEvaluatorIterationManager.ValueIterator[] createIterators(@NonNull
                                                                                                           TypedElement[] referredIterators,
                                                                                                           @NonNull
                                                                                                           Evaluator evaluator,
                                                                                                           @NonNull
                                                                                                           CollectionValue collectionValue)

Deprecated. use Executor

createIterators

@NonNull
protected static AbstractEvaluatorIterationManager.ValueIterator[] createIterators(@NonNull
                                                                                             TypedElement[] referredIterators,
                                                                                             @NonNull
                                                                                             Executor executor,
                                                                                             @NonNull
                                                                                             CollectionValue collectionValue)

Since:

1.1

dispose

public void dispose()

Specified by:

dispose in interface IterationManager

Overrides:

dispose in class AbstractIterationManager

evaluateBody

@Nullable
public java.lang.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.

getAccumulatorValue

@Nullable
public java.lang.Object getAccumulatorValue()

Description copied from interface: IterationManager

Get the current state of the accumulator.

getCollectionValue

@NonNull
public CollectionValue getCollectionValue()

getEvaluationEnvironment

@NonNull
public EvaluationEnvironment getEvaluationEnvironment()

getSourceCollection

@NonNull
public CollectionValue getSourceCollection()

Description copied from interface: IterationManager

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

updateAccumulator

@Nullable
public java.lang.Object updateAccumulator(java.lang.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.