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

Class DefaultFlowController

java.lang.Object

org.pentaho.reporting.engine.classic.core.states.datarow.DefaultFlowController

public class DefaultFlowController
extends Object

Constructor Summary

Constructors

Constructor	Description
DefaultFlowController(ProcessingContext reportContext, DataSchemaDefinition schemaDefinition, ReportParameterValues parameters, PerformanceMonitorContext performanceMonitorContext)

Method Summary

Modifier and Type	Method	Description
DefaultFlowController	activateExpressions(Expression[] expressions, boolean preserveState)
DefaultFlowController	clearRecordedCrosstabRowState()
protected MasterDataRow	createDataRow(ProcessingContext reportContext, DataSchemaDefinition schemaDefinition, ReportParameterValues parameters)
DefaultFlowController	deactivateExpressions()
DefaultFlowController	derive()
DefaultFlowController	endCrosstabMode()
DefaultFlowController	fireReportEvent(ReportEvent event)
DataFactory	getDataFactory()
DataSchema	getDataSchema()
String	getExportDescriptor()
MasterDataRow	getMasterRow()
ProcessingContext	getReportContext()
boolean	isAdvanceRequested()
boolean	isCrosstabActive()
boolean	isQueryLimitReached()
DefaultFlowController	performAdvance()
DefaultFlowController	performClearExportedParameters()
DefaultFlowController	performCommit()
DefaultFlowController	performDesignTimeQuery(DataFactory dataFactory, String query, int queryLimit, int queryTimeout, ResourceBundleFactory resourceBundleFactory)
DefaultFlowController	performInitSubreport(DataFactory dataFactory, ParameterMapping[] inputParameters, ResourceBundleFactory resourceBundleFactory)
DefaultFlowController	performQuery(DataFactory dataFactory, String query, int queryLimit, int queryTimeout, ResourceBundleFactory resourceBundleFactory)	Deprecated.
DefaultFlowController	performQuery(DataFactory dataFactory, String query, int queryLimit, int queryTimeout, ResourceBundleFactory resourceBundleFactory, List<SortConstraint> sortOrder)
protected TableModel	performQueryData(DataFactory dataFactory, String query, int queryLimit, int queryTimeout, DataRow parameters, boolean designTime, List<SortConstraint> sortConstraints)
DefaultFlowController	performReturnFromQuery()
DefaultFlowController	performReturnFromSubreport()
DefaultFlowController	performSubReportQuery(String query, int queryLimit, int queryTimeout, ParameterMapping[] outputParameters)	Deprecated.
DefaultFlowController	performSubReportQuery(String query, int queryLimit, int queryTimeout, ParameterMapping[] outputParameters, List<SortConstraint> sortConstraints)
DefaultFlowController	recordCrosstabRowState()
DefaultFlowController	refreshDataRow()
DefaultFlowController	replayStoredCrosstabRowState()
void	requireStructuralProcessing()
DefaultFlowController	resetRowCursor()
DefaultFlowController	restart()
void	setQueryLimitReached(boolean queryLimitReached)
DefaultFlowController	startCrosstabMode(CrosstabSpecification crosstabSpecification)
DefaultFlowController	updateDataSchema(DataSchemaDefinition dataSchemaDefinition)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFlowController

public DefaultFlowController(ProcessingContext reportContext,
                             DataSchemaDefinition schemaDefinition,
                             ReportParameterValues parameters,
                             PerformanceMonitorContext performanceMonitorContext)
                      throws ReportDataFactoryException

Throws:

ReportDataFactoryException

Method Detail

createDataRow

protected MasterDataRow createDataRow(ProcessingContext reportContext,
                                      DataSchemaDefinition schemaDefinition,
                                      ReportParameterValues parameters)

requireStructuralProcessing

public void requireStructuralProcessing()

derive

public DefaultFlowController derive()

performAdvance

public DefaultFlowController performAdvance()

performCommit

public DefaultFlowController performCommit()

getMasterRow

public MasterDataRow getMasterRow()

isAdvanceRequested

public boolean isAdvanceRequested()

performQuery

@Deprecated
public DefaultFlowController performQuery(DataFactory dataFactory,
                                          String query,
                                          int queryLimit,
                                          int queryTimeout,
                                          ResourceBundleFactory resourceBundleFactory)
                                   throws ReportDataFactoryException

Deprecated.

This should be called only once per report processing. A JFreeReport object defines the global master report - all other reports are subreport instances.

The global master report receives its parameter set from the Job-Definition, while subreports will read their parameters from the current datarow state.

Parameters:

query -

queryLimit -

queryTimeout -

Returns:

Throws:

ReportDataFactoryException

performQuery

public DefaultFlowController performQuery(DataFactory dataFactory,
                                          String query,
                                          int queryLimit,
                                          int queryTimeout,
                                          ResourceBundleFactory resourceBundleFactory,
                                          List<SortConstraint> sortOrder)
                                   throws ReportDataFactoryException

Throws:

ReportDataFactoryException

performDesignTimeQuery

public DefaultFlowController performDesignTimeQuery(DataFactory dataFactory,
                                                    String query,
                                                    int queryLimit,
                                                    int queryTimeout,
                                                    ResourceBundleFactory resourceBundleFactory)
                                             throws ReportDataFactoryException

Throws:

ReportDataFactoryException

performQueryData

protected TableModel performQueryData(DataFactory dataFactory,
                                      String query,
                                      int queryLimit,
                                      int queryTimeout,
                                      DataRow parameters,
                                      boolean designTime,
                                      List<SortConstraint> sortConstraints)
                               throws ReportDataFactoryException

Throws:

ReportDataFactoryException

performInitSubreport

public DefaultFlowController performInitSubreport(DataFactory dataFactory,
                                                  ParameterMapping[] inputParameters,
                                                  ResourceBundleFactory resourceBundleFactory)

performSubReportQuery

@Deprecated
public DefaultFlowController performSubReportQuery(String query,
                                                   int queryLimit,
                                                   int queryTimeout,
                                                   ParameterMapping[] outputParameters)
                                            throws ReportDataFactoryException

Deprecated.

Throws:

ReportDataFactoryException

performSubReportQuery

public DefaultFlowController performSubReportQuery(String query,
                                                   int queryLimit,
                                                   int queryTimeout,
                                                   ParameterMapping[] outputParameters,
                                                   List<SortConstraint> sortConstraints)
                                            throws ReportDataFactoryException

Throws:

ReportDataFactoryException

activateExpressions

public DefaultFlowController activateExpressions(Expression[] expressions,
                                                 boolean preserveState)
                                          throws ReportProcessingException

Throws:

ReportProcessingException

deactivateExpressions

public DefaultFlowController deactivateExpressions()

performReturnFromQuery

public DefaultFlowController performReturnFromQuery()

performReturnFromSubreport

public DefaultFlowController performReturnFromSubreport()

performClearExportedParameters

public DefaultFlowController performClearExportedParameters()

getExportDescriptor

public String getExportDescriptor()

getReportContext

public ProcessingContext getReportContext()

fireReportEvent

public DefaultFlowController fireReportEvent(ReportEvent event)

getDataSchema

public DataSchema getDataSchema()

getDataFactory

public DataFactory getDataFactory()

startCrosstabMode

public DefaultFlowController startCrosstabMode(CrosstabSpecification crosstabSpecification)

endCrosstabMode

public DefaultFlowController endCrosstabMode()

resetRowCursor

public DefaultFlowController resetRowCursor()

restart

public DefaultFlowController restart()

updateDataSchema

public DefaultFlowController updateDataSchema(DataSchemaDefinition dataSchemaDefinition)

refreshDataRow

public DefaultFlowController refreshDataRow()

isCrosstabActive

public boolean isCrosstabActive()

recordCrosstabRowState

public DefaultFlowController recordCrosstabRowState()

clearRecordedCrosstabRowState

public DefaultFlowController clearRecordedCrosstabRowState()

replayStoredCrosstabRowState

public DefaultFlowController replayStoredCrosstabRowState()

isQueryLimitReached

public boolean isQueryLimitReached()

setQueryLimitReached

public void setQueryLimitReached(boolean queryLimitReached)