info.monitorenter.gui.chart.traces.iterators.fsm

Class AIteratorITracePointStateEnginge

java.lang.Object

info.monitorenter.gui.chart.traces.iterators.AAccumulationIterator

info.monitorenter.gui.chart.traces.iterators.fsm.AIteratorITracePointStateEnginge

All Implemented Interfaces:

Iterator<ITracePoint2D>

Direct Known Subclasses:

IteratorTracePointStateEngine

public abstract class AIteratorITracePointStateEnginge
extends AAccumulationIterator

An iterator over trace points that works as a Finite State Machine by utilizing different state instances.

While this approach may look a bit over-designed I decided to use it after a plain-forward implementation of accumulation - iterators grew into spaghetti-code.

Author:

Achim Westermann

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AIteratorITracePointStateEnginge.AAction Overrides AIteratorITracePointStateEnginge.AAction.toString() to make this class-cluster a bit more debuggable.
class	AIteratorITracePointStateEnginge.ACondition Overrides AIteratorITracePointStateEnginge.ACondition.toString() to make this class-cluster a bit more debuggable.
static interface	AIteratorITracePointStateEnginge.IAction Interface for an action (upon a transition condition of a state) that knows how to compute the output given for the input.
static interface	AIteratorITracePointStateEnginge.ICondition Interface for a condition that folds the mealy input (ITracePoint2D ) into a boolean.
class	AIteratorITracePointStateEnginge.Transition Implementation of a transition.

Constructor Summary

Constructors

Constructor and Description
AIteratorITracePointStateEnginge(ITrace2D originalTrace, IAccumulationFunction accumulationFunction, IAccumulationStrategy.IAccumulationControl accumulationControl) Constructor with all that is needed for accumulating points.

Method Summary

Modifier and Type	Method and Description
protected ITracePoint2D	getPreviousPoint() Returns the previous point read from the underlying iterator.
protected List<AIteratorITracePointStateEnginge.Transition>[]	getTransitionTable() Returns the transitionTable.
boolean	hasNext()
protected abstract List<AIteratorITracePointStateEnginge.Transition>[]	initTransitionTable() Template method to initialize your transition table here.
ITracePoint2D	next()
void	reset(ITrace2D trace) Allows to reuse this instance (by resetting to the initial state) with the given trace.
protected void	setStartState(Enum<?> startState) Sets the startState.

Methods inherited from class info.monitorenter.gui.chart.traces.iterators.AAccumulationIterator

getAccumulationControl, getAccumulationFunction, getOriginalIterator, getOriginalTrace, remove, setOriginalTrace

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

AIteratorITracePointStateEnginge

public AIteratorITracePointStateEnginge(ITrace2D originalTrace,
                                        IAccumulationFunction accumulationFunction,
                                        IAccumulationStrategy.IAccumulationControl accumulationControl)

Constructor with all that is needed for accumulating points.

Parameters:

originalTrace - the iterator to decorate with the feature of accumulating points.

accumulationFunction - the function to use for point - accumulation.

accumulationControl - termination criteria for a single accumulation run.

Method Detail

getPreviousPoint

protected ITracePoint2D getPreviousPoint()

Returns the previous point read from the underlying iterator.

Returns:

the previousPoint encountered

getTransitionTable

protected List<AIteratorITracePointStateEnginge.Transition>[] getTransitionTable()

Returns the transitionTable.

Returns:

the transitionTable

setStartState

protected void setStartState(Enum<?> startState)

Sets the startState.

Parameters:

startState - the startState to set

reset

public void reset(ITrace2D trace)

Allows to reuse this instance (by resetting to the initial state) with the given trace.

This skips setting up the internal transition table (see initTransitionTable() anew and therefore bypasses unnecessary computations.

Parameters:

trace - the new trace this iterator will work for.

initTransitionTable

protected abstract List<AIteratorITracePointStateEnginge.Transition>[] initTransitionTable()

Template method to initialize your transition table here. The start state has to be at position 0.

You also have to setStartState(Enum) to the first enum in your STATES enum.

After this subsequent calls to next() should be OK.

Returns:

transitionTable the filled transition table.

hasNext

public boolean hasNext()

See Also:

Iterator.hasNext()

next

public ITracePoint2D next()

See Also:

Iterator.next()