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

java.lang.Object
  extended by org.pentaho.reporting.engine.classic.core.states.datarow.DefaultFlowController

public final class DefaultFlowController
extends Object

Creation-Date: 20.02.2006, 15:30:21

Author:
Thomas Morgner

Constructor Summary
DefaultFlowController(ProcessingContext reportContext, DataSchemaDefinition schemaDefinition, ReportParameterValues parameters, ParameterDefinitionEntry[] parameterDefinitionEntries, boolean includeStructuralPreprocessing)
           
 
Method Summary
 DefaultFlowController activateExpressions(Expression[] expressions, boolean preserveState)
           
 DefaultFlowController deactivateExpressions()
           
 DefaultFlowController derive()
           
 DefaultFlowController endCrosstabMode()
           
 DefaultFlowController fireReportEvent(ReportEvent event)
           
 int getCurrentCrosstabPaddingItem()
           
 int getCursor()
           
 DataFactory getDataFactory()
           
 DataSchema getDataSchema()
           
 String getExportDescriptor()
           
 MasterDataRow getMasterRow()
           
 ProcessingContext getReportContext()
           
 boolean isAdvanceRequested()
           
 DefaultFlowController performAdvance()
           
 DefaultFlowController performClearExportedParameters()
           
 DefaultFlowController performCommit()
           
 DefaultFlowController performInitSubreport(DataFactory dataFactory, ParameterMapping[] inputParameters, ResourceBundleFactory resourceBundleFactory)
           
 DefaultFlowController performQuery(DataFactory dataFactory, String query, int queryLimit, int queryTimeout, ResourceBundleFactory resourceBundleFactory)
          This should be called only once per report processing.
 DefaultFlowController performReturnFromQuery()
           
 DefaultFlowController performReturnFromSubreport()
           
 DefaultFlowController performSubReportQuery(String query, int queryLimit, int queryTimeout, ParameterMapping[] outputParameters)
           
 DefaultFlowController resetRowCursor()
           
 DefaultFlowController restart()
           
 DefaultFlowController startCrosstabMode(CrosstabSpecification crosstabSpecification)
           
 DefaultFlowController updateDataSchema(DataSchemaDefinition dataSchemaDefinition)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultFlowController

public DefaultFlowController(ProcessingContext reportContext,
                             DataSchemaDefinition schemaDefinition,
                             ReportParameterValues parameters,
                             ParameterDefinitionEntry[] parameterDefinitionEntries,
                             boolean includeStructuralPreprocessing)
                      throws ReportDataFactoryException
Throws:
ReportDataFactoryException
Method Detail

derive

public DefaultFlowController derive()

performAdvance

public DefaultFlowController performAdvance()

performCommit

public DefaultFlowController performCommit()

getMasterRow

public MasterDataRow getMasterRow()

isAdvanceRequested

public boolean isAdvanceRequested()

performQuery

public DefaultFlowController performQuery(DataFactory dataFactory,
                                          String query,
                                          int queryLimit,
                                          int queryTimeout,
                                          ResourceBundleFactory resourceBundleFactory)
                                   throws ReportDataFactoryException
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

performInitSubreport

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

performSubReportQuery

public DefaultFlowController performSubReportQuery(String query,
                                                   int queryLimit,
                                                   int queryTimeout,
                                                   ParameterMapping[] outputParameters)
                                            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)

getCursor

public int getCursor()

getDataSchema

public DataSchema getDataSchema()

getDataFactory

public DataFactory getDataFactory()

startCrosstabMode

public DefaultFlowController startCrosstabMode(CrosstabSpecification crosstabSpecification)

endCrosstabMode

public DefaultFlowController endCrosstabMode()

getCurrentCrosstabPaddingItem

public int getCurrentCrosstabPaddingItem()

resetRowCursor

public DefaultFlowController resetRowCursor()

restart

public DefaultFlowController restart()

updateDataSchema

public DefaultFlowController updateDataSchema(DataSchemaDefinition dataSchemaDefinition)