net.sf.reportengine.core.steps

Class GroupLevelDetectorStep

java.lang.Object

net.sf.reportengine.core.algorithm.steps.AbstractAlgoMainStep<T,U,V>

net.sf.reportengine.core.AbstractReportStep<String,Integer,String>

net.sf.reportengine.core.steps.GroupLevelDetectorStep

All Implemented Interfaces:

AlgorithmMainStep<String,Integer,String>

Direct Known Subclasses:

IntermedGroupLevelDetectorStep

public class GroupLevelDetectorStep
extends AbstractReportStep<String,Integer,String>

this computes the aggregation level for the current dataEvent. The protocol is :

• when returning the level -1 then a simple data row has been found ( none of the aggregation columns has been changed )
• any level > 0 returned is the index of the first element changed in the aggregation columns.

Example:
Let's assume that we have a data matrix like :

1	2	3	4
1	2	3	5
1	1	6	7
2	8	6	7

and all the columns {0,1,2} as grouping columns then :
when passing the first row to the execute method the result level will be -1
when passing the second row to the same method the result will be -1 (because none of the columns 0,1,2 have changed)
when passing the third row to the same method the result will be 1 (because this is the index of the first changed column)
when passing the second row to the same method the result will be 0

Since:

0.4

Author:

dragos balan (dragos dot balan at gmail dot com)

Field Summary

Fields inherited from class net.sf.reportengine.core.AbstractReportStep

GRAND_TOTAL_GROUPING_LEVEL

Constructor Summary

Constructors

Constructor and Description
GroupLevelDetectorStep()

Method Summary

Modifier and Type	Method and Description
StepResult<Integer>	execute(NewRowEvent newRowEvent, StepInput stepInput) execute method
StepResult<String>	exit(StepInput stepInput) called when finishing the algorithm execution
StepResult<String>	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.

Methods inherited from class net.sf.reportengine.core.AbstractReportStep

computeAggLevelForCalcRowNumber, computeCalcRowNumberForAggLevel, getCalcIntermResultsMatrix, getCalculatorDistributionInColumnDataArray, getDataColumns, getDataColumnsLength, getDataRowCount, getGroupColumns, getGroupColumnsCount, getGroupingLevel, getPreviousRowOfGroupValues, getShowGrandTotal, getShowTotals, getTotalStringForGroupingLevel, getTotalStringForGroupingLevelAndPredecessors, getTotalStringForGroupingLevelAndPredecessors

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupLevelDetectorStep

public GroupLevelDetectorStep()

Method Detail

execute

public StepResult<Integer> execute(NewRowEvent newRowEvent,
                                   StepInput stepInput)

execute method

stepInput - TODO

Returns:

TODO

init

public StepResult<String> init(StepInput stepInput)

Description copied from interface: AlgorithmMainStep

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

exit

public StepResult<String> exit(StepInput stepInput)

Description copied from interface: AlgorithmMainStep

called when finishing the algorithm execution