net.sf.reportengine.core.steps.crosstab

Class DistinctValuesDetectorStep

java.lang.Object

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

net.sf.reportengine.core.AbstractReportStep<T,U,V>

net.sf.reportengine.core.steps.crosstab.AbstractCrosstabStep<DistinctValuesHolder,IntermediateDataInfo,String>

net.sf.reportengine.core.steps.crosstab.DistinctValuesDetectorStep

All Implemented Interfaces:

AlgorithmMainStep<DistinctValuesHolder,IntermediateDataInfo,String>

public class DistinctValuesDetectorStep
extends AbstractCrosstabStep<DistinctValuesHolder,IntermediateDataInfo,String>

Mainly this step detects the distinct values appearing on crosstabHeadersRows. Another task of this step is to construct the intermediate crosstab data info object containing the value of the crosstabData and the position of the crosstabData relative to the crosstab header rows. Few details about this array below: this is an array holding the coordinates for the current crosstabData relative to the rows of the header. For instance, let's assume we have the following row header: level 0: key=Region distinctValues= North, South, East, West level 1: key=Sex distinctValues= Males, Females and let's assume the current row is : Argentina, East, Females, 100 (where Argentina is on a group column and North and Females are declared on headerRows, 100 - crosstab data) for this row the relative position to the row header will be : index 0: 2 ( because East is the third in the Region distinct values) index 1: 1 ( because Females is the second in the Sex distinct values) so the array will look like [2,1]

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
DistinctValuesDetectorStep()

Method Summary

Modifier and Type	Method and Description
StepResult<IntermediateDataInfo>	execute(NewRowEvent newRowEvent, StepInput stepInput) callback method called for each row
StepResult<String>	exit(StepInput stepInput) called when finishing the algorithm execution
StepResult<DistinctValuesHolder>	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.steps.crosstab.AbstractCrosstabStep

getCrosstabData, getCrosstabHeaderRows, getCrosstabHeaderRowsLength, getDistinctValuesHolder, getIntermCrosstabOutput, getIntermediateCrosstabDataInfo, getIntermediateRow, getPositionOfTotal, getShowTotalsInHeader

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

DistinctValuesDetectorStep

public DistinctValuesDetectorStep()

Method Detail

init

public StepResult<DistinctValuesHolder> 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

execute

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

Description copied from interface: AlgorithmMainStep

callback method called for each row

stepInput - TODO

Returns:

TODO

exit

public StepResult<String> exit(StepInput stepInput)

Description copied from interface: AlgorithmMainStep

called when finishing the algorithm execution