net.sf.reportengine.core

Class AbstractReportStep<T,U,V>

java.lang.Object

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

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

All Implemented Interfaces:

AlgorithmMainStep<T,U,V>

Direct Known Subclasses:

AbstractCrosstabStep, AbstractOutputStep, ExternalSortPreparationStep, GroupLevelDetectorStep, InMemorySortStep, PreviousRowManagerStep, TotalsCalculatorStep

public abstract class AbstractReportStep<T,U,V>
extends AbstractAlgoMainStep<T,U,V>

Default implementation for a step in the algorithm

Since:

0.2

Author:

dragos balan

Field Summary

Fields

Modifier and Type	Field and Description
static int	GRAND_TOTAL_GROUPING_LEVEL constant for grand total grouping level

Constructor Summary

Constructors

Constructor and Description
AbstractReportStep()

Method Summary

Modifier and Type	Method and Description
int	computeAggLevelForCalcRowNumber(StepInput stepInput, int calcRowNumber) computes the aggregation level for the given row of the calculators matrix
int	computeCalcRowNumberForAggLevel(StepInput stepInput, int level) computes the row number (from the calculators matrix) where the totals are for the given level
CalcIntermResult[][]	getCalcIntermResultsMatrix(StepInput stepInput) returns the calculator within context
ArrayList<Integer>	getCalculatorDistributionInColumnDataArray(StepInput stepInput) getter for the distribution of calculators in data columns array
List<DataColumn>	getDataColumns(StepInput stepInput) ATTENTION : changing the implementation of this method will have effect on the following methods: #getDataColumnsLength()
int	getDataColumnsLength(StepInput stepInput)
Integer	getDataRowCount(StepInput stepInput) returns the data row count from the report context
List<GroupColumn>	getGroupColumns(StepInput stepInput) ATTENTION : changing the implementation of this method will have effect on the following methods: #getGroupColumnsCount() #computeAggLevelForCalcRowNumber(int) #computeCalcRowNumberForAggLevel(int)
int	getGroupColumnsCount(StepInput stepInput)
int	getGroupingLevel(StepInput stepInput)
Object[]	getPreviousRowOfGroupValues(StepInput stepInput)
boolean	getShowGrandTotal(StepInput stepInput)
boolean	getShowTotals(StepInput stepInput)
String	getTotalStringForGroupingLevel(StepInput stepInput, String calculatorLabels, int groupingLevel)
Object[]	getTotalStringForGroupingLevelAndPredecessors(StepInput stepInput, int groupingLevel)
Object[]	getTotalStringForGroupingLevelAndPredecessors(StepInput stepInput, int from, int groupingLevel)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.reportengine.core.algorithm.steps.AlgorithmMainStep

execute, exit, init

Field Detail

GRAND_TOTAL_GROUPING_LEVEL

public static final int GRAND_TOTAL_GROUPING_LEVEL

constant for grand total grouping level

See Also:

Constant Field Values

Constructor Detail

AbstractReportStep

public AbstractReportStep()

Method Detail

getGroupingLevel

public int getGroupingLevel(StepInput stepInput)

Returns:

the grouping level

getCalcIntermResultsMatrix

public CalcIntermResult[][] getCalcIntermResultsMatrix(StepInput stepInput)

returns the calculator within context

Returns:

getCalculatorDistributionInColumnDataArray

public ArrayList<Integer> getCalculatorDistributionInColumnDataArray(StepInput stepInput)

getter for the distribution of calculators in data columns array

Returns:

getDataColumns

public List<DataColumn> getDataColumns(StepInput stepInput)

ATTENTION : changing the implementation of this method will have effect on the following methods: #getDataColumnsLength()

Returns:

getDataColumnsLength

public int getDataColumnsLength(StepInput stepInput)

Returns:

getGroupColumns

public List<GroupColumn> getGroupColumns(StepInput stepInput)

ATTENTION : changing the implementation of this method will have effect on the following methods: #getGroupColumnsCount() #computeAggLevelForCalcRowNumber(int) #computeCalcRowNumberForAggLevel(int)

Returns:

getGroupColumnsCount

public int getGroupColumnsCount(StepInput stepInput)

getShowGrandTotal

public boolean getShowGrandTotal(StepInput stepInput)

getShowTotals

public boolean getShowTotals(StepInput stepInput)

computeCalcRowNumberForAggLevel

public int computeCalcRowNumberForAggLevel(StepInput stepInput,
                                           int level)

computes the row number (from the calculators matrix) where the totals are for the given level

Parameters:

level - the aggregation level

Returns:

computeAggLevelForCalcRowNumber

public int computeAggLevelForCalcRowNumber(StepInput stepInput,
                                           int calcRowNumber)

computes the aggregation level for the given row of the calculators matrix

Parameters:

calcRowNumber -

Returns:

getPreviousRowOfGroupValues

public Object[] getPreviousRowOfGroupValues(StepInput stepInput)

Returns:

getTotalStringForGroupingLevel

public String getTotalStringForGroupingLevel(StepInput stepInput,
                                             String calculatorLabels,
                                             int groupingLevel)

Parameters:

groupingLevel -

Returns:

getTotalStringForGroupingLevelAndPredecessors

public Object[] getTotalStringForGroupingLevelAndPredecessors(StepInput stepInput,
                                                              int groupingLevel)

Parameters:

groupingLevel -

Returns:

getTotalStringForGroupingLevelAndPredecessors

public Object[] getTotalStringForGroupingLevelAndPredecessors(StepInput stepInput,
                                                              int from,
                                                              int groupingLevel)

Parameters:

from -

groupingLevel -

Returns:

getDataRowCount

public Integer getDataRowCount(StepInput stepInput)

returns the data row count from the report context

Returns: