Package net.ssehub.easy.varModel.cstEvaluation

Interface IIteratorEvaluator

All Known Implementing Classes:

ContainerIterators.ClosureIteratorEvaluator, ContainerIterators.CollectingIteratorEvaluator, ContainerIterators.CollectIteratorEvaluator, ContainerIterators.NumberIteratorEvaluator

public interface IIteratorEvaluator

Provides an iterator aggregation function. Please note that aggregation functions do not have a state, i.e., no own memory.

Author:

Holger Eichelberger

Method Summary

Modifier and Type	Method	Description
Value	aggregate(EvaluationAccessor result, Value iter, EvaluationAccessor value, java.util.Map<java.lang.Object,java.lang.Object> data)	Aggregate value to result.
Value	getStartResult(IDatatype type, IDatatype iterType)	Returns the start result.
void	postProcessResult(EvaluationAccessor result, java.util.Map<java.lang.Object,java.lang.Object> data)	Called to post-process the actual result at the end after the last iteration.

Method Detail

getStartResult

Value getStartResult(IDatatype type,
                     IDatatype iterType)
              throws ValueDoesNotMatchTypeException

Returns the start result. Used in case of all operations where the start result is implicitly clear from the operation itself and not explicitly defined in the model.

Parameters:

type - the type of the return value

iterType - the type of the iterator expression

Returns:

the start value (must comply to type)

Throws:

ValueDoesNotMatchTypeException - in case of type compatibility problems

aggregate

Value aggregate(EvaluationAccessor result,
                Value iter,
                EvaluationAccessor value,
                java.util.Map<java.lang.Object,java.lang.Object> data)
         throws ValueDoesNotMatchTypeException

Aggregate value to result.

Parameters:

result - the aggregating result

iter - the current value of the iterator

value - the value to be aggregated

data - arbitrary data to be hold while actually evaluating the function

Returns:

a boolean value to indicate whether iteration/evaluation shall stop (true if iteration shall stop due to this evaluation, false else), a collection of values as instance of ListWrapperValue where to go on

Throws:

ValueDoesNotMatchTypeException - in case of type compatibility problems

postProcessResult

void postProcessResult(EvaluationAccessor result,
                       java.util.Map<java.lang.Object,java.lang.Object> data)
                throws ValueDoesNotMatchTypeException

Called to post-process the actual result at the end after the last iteration.

Parameters:

result - the aggregated result so far

data - arbitrary data to be hold while actually evaluating the function

Throws:

ValueDoesNotMatchTypeException - in case of type compatibility problems