Package org.pentaho.reporting.engine.classic.core.states.process

Class ProcessState

java.lang.Object

org.pentaho.reporting.engine.classic.core.states.process.ProcessState

All Implemented Interfaces:

Cloneable, ReportState

public class ProcessState
extends Object
implements ReportState

Field Summary

Fields

Modifier and Type	Field	Description
static int	ARTIFICIAL_EVENT_CODE

Fields inherited from interface org.pentaho.reporting.engine.classic.core.states.ReportState

BEFORE_FIRST_GROUP, BEFORE_FIRST_ROW

Constructor Summary

Constructors

Constructor	Description
ProcessState()

Method Summary

Modifier and Type	Method	Description
ProcessState	advance()
void	advanceCursor()
void	clearStoredCrosstabRowState()
ProcessState	clone()
ProcessState	commit()
GroupingState	createGroupingState()
void	crosstabIncrementColumnCounter()
void	crosstabResetColumnIndices()
ProcessState	deriveForAdvance()
ProcessState	deriveForPagebreak()	This is a more expensive version of the ordinary derive.
ProcessState	deriveForStorage()
void	enterGroup()
void	enterPresentationGroup()
ProcessState	finishReplayingStoredCrosstabRowState()
void	firePageFinishedEvent(boolean noParentPassing)	Fires a 'page-finished' event.
void	firePageStartedEvent(int baseEvent)	Fires a 'page-started' event.
protected void	fireReportEvent()
AdvanceHandler	getAdvanceHandler()
long	getCrosstabColumnSequenceCounter(int groupIndex)
int	getCurrentDataItem()	Returns the current data item.
int	getCurrentGroupIndex()
int	getCurrentRow()	Returns the currently processed row number.
int	getCurrentSubReport()
InlineSubreportMarker	getCurrentSubReportMarker()
DataRow	getDataRow()
ReportProcessingErrorHandler	getErrorHandler()
int	getEventCode()	Returns the unique event code for this report state type.
DefaultFlowController	getFlowController()
FunctionStorage	getFunctionStorage()
long	getGroupSequenceCounter(int groupIndex)
LayoutProcess	getLayoutProcess()
int	getLevel()
int	getNumberOfRows()
ReportState	getParentState()
ReportState	getParentSubReportState()
PerformanceMonitorContext	getPerformanceMonitorContext()
AdvanceHandler	getPostSummaryRowAdvanceHandler()
Integer	getPredictedStateCount()
int	getPresentationGroupIndex()
ProcessStateHandle	getProcessHandle()
ReportStateKey	getProcessKey()
ReportProcessStore	getProcessStore()
int	getProgressLevel()
int	getProgressLevelCount()
int	getReplayStoredCrosstabGroup()
ReportDefinition	getReport()
int[]	getRequiredRuntimeLevels()
ResourceBundleFactory	getResourceBundleFactory()
int	getSequenceCounter()
FunctionStorage	getStructureFunctionStorage()
SubReportProcessType	getSubreportProcessingType()
InlineSubreportMarker[]	getSubReports()
boolean	initializeForMasterReport(MasterReport report, ProcessingContext processingContext, OutputFunction outputFunction)
void	initializeForSubreport(InlineSubreportMarker[] subReports, int subReportIndex, ProcessState parentState)
boolean	isArtifcialState()
boolean	isCrosstabActive()
boolean	isFinish()
boolean	isInItemGroup()
boolean	isInlineProcess()
static boolean	isLastItemInGroup(Group rootGroup, MasterDataRow currentDataRow, MasterDataRow nextDataRow)	Returns true if this is the last item in the group, and false otherwise.
boolean	isPrepareRun()
boolean	isStructuralPreprocessingNeeded()
boolean	isSubReportEvent()
boolean	isSubReportExecutable()
void	leaveGroup()
void	leavePresentationGroup()
ProcessState	recordCrosstabRowState()
ProcessState	replayStoredCrosstabRowState()	Reset the state to use the stored flow-controller for the summary calculation.
ProcessState	restart()
ProcessState	returnFromSubReport(LayoutProcess layoutProcess)
void	setAdvanceHandler(AdvanceHandler advanceHandler)
void	setErrorHandler(ReportProcessingErrorHandler errorHandler)
void	setFlowController(DefaultFlowController flowController)
void	setInItemGroup(boolean inItemGroup)
void	setPostSummaryRowAdvanceHandler(AdvanceHandler postSummaryRowAdvanceHandler)
void	setSequenceCounter(int sequenceCounter)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ARTIFICIAL_EVENT_CODE

public static final int ARTIFICIAL_EVENT_CODE

See Also:

Constant Field Values

Constructor Detail

ProcessState

public ProcessState()

Method Detail

initializeForMasterReport

public boolean initializeForMasterReport(MasterReport report,
                                         ProcessingContext processingContext,
                                         OutputFunction outputFunction)
                                  throws ReportProcessingException

Throws:

ReportProcessingException

initializeForSubreport

public void initializeForSubreport(InlineSubreportMarker[] subReports,
                                   int subReportIndex,
                                   ProcessState parentState)
                            throws ReportProcessingException

Throws:

ReportProcessingException

getProcessStore

public ReportProcessStore getProcessStore()

Specified by:

getProcessStore in interface ReportState

getRequiredRuntimeLevels

public int[] getRequiredRuntimeLevels()

isSubReportExecutable

public boolean isSubReportExecutable()

returnFromSubReport

public ProcessState returnFromSubReport(LayoutProcess layoutProcess)
                                 throws ReportProcessingException

Throws:

ReportProcessingException

restart

public ProcessState restart()
                     throws ReportProcessingException

Throws:

ReportProcessingException

getErrorHandler

public ReportProcessingErrorHandler getErrorHandler()

Specified by:

getErrorHandler in interface ReportState

setErrorHandler

public void setErrorHandler(ReportProcessingErrorHandler errorHandler)

Specified by:

setErrorHandler in interface ReportState

setSequenceCounter

public void setSequenceCounter(int sequenceCounter)

getSequenceCounter

public int getSequenceCounter()

getCurrentSubReportMarker

public InlineSubreportMarker getCurrentSubReportMarker()

Specified by:

getCurrentSubReportMarker in interface ReportState

isInlineProcess

public boolean isInlineProcess()

Specified by:

isInlineProcess in interface ReportState

getSubreportProcessingType

public SubReportProcessType getSubreportProcessingType()

deriveForPagebreak

public ProcessState deriveForPagebreak()

This is a more expensive version of the ordinary derive. This method creates a separate copy of the layout-process so that this operation is expensive in memory and CPU usage.

Returns:

the derived state.

deriveForAdvance

public ProcessState deriveForAdvance()

deriveForStorage

public ProcessState deriveForStorage()

clone

public ProcessState clone()
                   throws CloneNotSupportedException

Specified by:

clone in interface ReportState

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getAdvanceHandler

public AdvanceHandler getAdvanceHandler()

setAdvanceHandler

public void setAdvanceHandler(AdvanceHandler advanceHandler)

advance

public final ProcessState advance()
                           throws ReportProcessingException

Throws:

ReportProcessingException

commit

public final ProcessState commit()
                          throws ReportProcessingException

Throws:

ReportProcessingException

getCurrentRow

public int getCurrentRow()

Description copied from interface: ReportState

Returns the currently processed row number. This row number contains padded rows and is equivalent to the number of advance() calls made on the master-datarow.

Specified by:

getCurrentRow in interface ReportState

Returns:

the current row number.

getCurrentDataItem

public int getCurrentDataItem()

Description copied from interface: ReportState

Returns the current data item. The data item is the row number used to access the raw data in the tablemodel. This number is not guaranteed to increase sequentially as sorting may affect the order of rows.

Specified by:

getCurrentDataItem in interface ReportState

Returns:

the current raw access row number.

getProgressLevel

public int getProgressLevel()

Specified by:

getProgressLevel in interface ReportState

getProgressLevelCount

public int getProgressLevelCount()

Specified by:

getProgressLevelCount in interface ReportState

isPrepareRun

public boolean isPrepareRun()

Specified by:

isPrepareRun in interface ReportState

getLevel

public int getLevel()

Specified by:

getLevel in interface ReportState

isFinish

public boolean isFinish()

Specified by:

isFinish in interface ReportState

getEventCode

public int getEventCode()

Description copied from interface: ReportState

Returns the unique event code for this report state type.

Specified by:

getEventCode in interface ReportState

Returns:

the event code for this state type.

getCurrentGroupIndex

public int getCurrentGroupIndex()

Specified by:

getCurrentGroupIndex in interface ReportState

enterGroup

public void enterGroup()

leaveGroup

public void leaveGroup()

getPresentationGroupIndex

public int getPresentationGroupIndex()

Specified by:

getPresentationGroupIndex in interface ReportState

enterPresentationGroup

public void enterPresentationGroup()

leavePresentationGroup

public void leavePresentationGroup()

getReport

public ReportDefinition getReport()

Specified by:

getReport in interface ReportState

getCurrentSubReport

public int getCurrentSubReport()

getParentState

public ReportState getParentState()

Specified by:

getParentState in interface ReportState

getParentSubReportState

public ReportState getParentSubReportState()

Specified by:

getParentSubReportState in interface ReportState

getStructureFunctionStorage

public FunctionStorage getStructureFunctionStorage()

getFunctionStorage

public FunctionStorage getFunctionStorage()

getFlowController

public DefaultFlowController getFlowController()

Specified by:

getFlowController in interface ReportState

setFlowController

public void setFlowController(DefaultFlowController flowController)

getLayoutProcess

public LayoutProcess getLayoutProcess()

Specified by:

getLayoutProcess in interface ReportState

getProcessKey

public ReportStateKey getProcessKey()

Specified by:

getProcessKey in interface ReportState

getDataRow

public DataRow getDataRow()

Specified by:

getDataRow in interface ReportState

getNumberOfRows

public int getNumberOfRows()

Specified by:

getNumberOfRows in interface ReportState

firePageStartedEvent

public void firePageStartedEvent(int baseEvent)

Fires a 'page-started' event.

Specified by:

firePageStartedEvent in interface ReportState

Parameters:

baseEvent - the type of the base event which caused the page start to be triggered.

firePageFinishedEvent

public void firePageFinishedEvent(boolean noParentPassing)

Fires a 'page-finished' event. The pageFinished(...) method is called for every report function.

Specified by:

firePageFinishedEvent in interface ReportState

fireReportEvent

protected void fireReportEvent()

isLastItemInGroup

public static boolean isLastItemInGroup(Group rootGroup,
                                        MasterDataRow currentDataRow,
                                        MasterDataRow nextDataRow)

Returns true if this is the last item in the group, and false otherwise. This checks the group condition and all conditions of all subgroups.

Parameters:

rootGroup - the root group that should be checked.

currentDataRow - the current data row.

nextDataRow - the next data row, or null, if this is the last datarow.

Returns:

A flag indicating whether or not the current item is the last in its group.

isSubReportEvent

public boolean isSubReportEvent()

Specified by:

isSubReportEvent in interface ReportState

getSubReports

public InlineSubreportMarker[] getSubReports()

getProcessHandle

public ProcessStateHandle getProcessHandle()

setInItemGroup

public void setInItemGroup(boolean inItemGroup)

isInItemGroup

public boolean isInItemGroup()

Specified by:

isInItemGroup in interface ReportState

getResourceBundleFactory

public ResourceBundleFactory getResourceBundleFactory()

Specified by:

getResourceBundleFactory in interface ReportState

isArtifcialState

public boolean isArtifcialState()

createGroupingState

public GroupingState createGroupingState()

Specified by:

createGroupingState in interface ReportState

isStructuralPreprocessingNeeded

public boolean isStructuralPreprocessingNeeded()

Specified by:

isStructuralPreprocessingNeeded in interface ReportState

advanceCursor

public void advanceCursor()

getPredictedStateCount

public Integer getPredictedStateCount()

Specified by:

getPredictedStateCount in interface ReportState

isCrosstabActive

public boolean isCrosstabActive()

Specified by:

isCrosstabActive in interface ReportState

toString

public String toString()

Overrides:

toString in class Object

recordCrosstabRowState

public ProcessState recordCrosstabRowState()

replayStoredCrosstabRowState

public ProcessState replayStoredCrosstabRowState()

Reset the state to use the stored flow-controller for the summary calculation.

Returns:

getReplayStoredCrosstabGroup

public int getReplayStoredCrosstabGroup()

getPostSummaryRowAdvanceHandler

public AdvanceHandler getPostSummaryRowAdvanceHandler()

setPostSummaryRowAdvanceHandler

public void setPostSummaryRowAdvanceHandler(AdvanceHandler postSummaryRowAdvanceHandler)

finishReplayingStoredCrosstabRowState

public ProcessState finishReplayingStoredCrosstabRowState()
                                                   throws ReportProcessingException

Throws:

ReportProcessingException

clearStoredCrosstabRowState

public void clearStoredCrosstabRowState()

getGroupSequenceCounter

public long getGroupSequenceCounter(int groupIndex)

Specified by:

getGroupSequenceCounter in interface ReportState

getCrosstabColumnSequenceCounter

public long getCrosstabColumnSequenceCounter(int groupIndex)

Specified by:

getCrosstabColumnSequenceCounter in interface ReportState

crosstabResetColumnIndices

public void crosstabResetColumnIndices()

crosstabIncrementColumnCounter

public void crosstabIncrementColumnCounter()

getPerformanceMonitorContext

public PerformanceMonitorContext getPerformanceMonitorContext()

Specified by:

getPerformanceMonitorContext in interface ReportState