net.sf.reportengine.core.algorithm.steps

Interface AlgorithmMainStep<T,U,V>

All Known Implementing Classes:

AbstractAlgoMainStep, AbstractCrosstabStep, AbstractOutputStep, AbstractReportStep, DataRowsOutputStep, DistinctValuesDetectorStep, ExternalSortPreparationStep, FlatTableTotalsOutputStep, GroupLevelDetectorStep, InMemorySortStep, IntermedDataRowsOutputStep, IntermedGroupLevelDetectorStep, IntermedPreviousRowManagerStep, IntermedRowMangerStep, IntermedTotalsCalculatorStep, IntermedTotalsOutputStep, PreviousRowManagerStep, TotalsCalculatorStep

public interface AlgorithmMainStep<T,U,V>

Interface step in the algorithm. The general contract is that : 1. init() method is called after all useful values have been set 2. exit() method is called after all executions have been done

Author:

dragos balan (dragos.balan@gmail.com)

Method Summary

Modifier and Type	Method and Description
StepResult<U>	execute(NewRowEvent newRowEvent, StepInput stepInput) callback method called for each row
StepResult<V>	exit(StepInput stepInput) called when finishing the algorithm execution
StepResult<T>	init(StepInput stepInput) this method is called only once for a report and represents the construction step where you can define the keys and values used inside the execute method.

Method Detail

init

StepResult<T> init(StepInput stepInput)

this method is called only once for a report and represents the construction step where you can define the keys and values used inside the execute method. Warning: this is the only place where you can add keys to the report context

Parameters:

stepInput - TODO

Returns:

TODO

execute

StepResult<U> execute(NewRowEvent newRowEvent,
                      StepInput stepInput)

callback method called for each row

Parameters:

newRowEvent -

stepInput - TODO

Returns:

TODO

exit

StepResult<V> exit(StepInput stepInput)

called when finishing the algorithm execution