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

java.lang.Object
  extended by org.pentaho.reporting.engine.classic.core.states.datarow.GlobalMasterRow
All Implemented Interfaces:
MasterDataRow

public final class GlobalMasterRow
extends Object
implements MasterDataRow

Creation-Date: Dec 13, 2006, 2:52:23 PM

Author:
Thomas Morgner

Method Summary
 MasterDataRow advance()
          This advances the cursor by one row and updates the flags.
 MasterDataRow advanceRecursively(boolean deepTraversingOnly, MasterDataRow subReportRow)
          This method is public as a implementation sideeffect.
 MasterDataRow clearExportedParameters()
           
static GlobalMasterRow createReportRow(ProcessingContext reportContext, DataSchemaDefinition schemaDefinition, ParameterDataRow parameterDataRow, ParameterDefinitionEntry[] parameterDefinitionEntries, boolean includeStucturalProcessing)
          Creates a new master-row.
 void dataRowChanged(MasterDataRowChangeEvent chEvent)
           
 MasterDataRow derive()
           
 MasterDataRow deriveSubDataRow(ProcessingContext reportContext, DataFactory reportFactory, ParameterDataRow parameterDataRow, ParameterDefinitionEntry[] parameterDefinitionEntries, ResourceBundleFactory resourceBundleFactory)
           
 MasterDataRow deriveWithQueryData(ReportDataRow tableData)
           
 MasterDataRow deriveWithReturnFromQuery()
           
 MasterDataRow endCrosstabMode()
           
 void fireReportEvent(ReportEvent event)
           
 DataFactory getDataFactory()
           
 DataSchema getDataSchema()
           
 DataSchemaDefinition getDataSchemaDefinition()
           
 ReportEnvironmentDataRow getEnvironmentDataRow()
           
 ExpressionDataRow getExpressionDataRow()
           
 DataRow getGlobalView()
           
 ImportedVariablesDataRow getImportedDataRow()
          The datarow that contains the values as imported from the subreport.
 ParameterDataRow getParameterDataRow()
           
 ParameterDefinitionEntry[] getParameterDefinitionEntries()
           
 MasterDataRow getParentDataRow()
           
 int getPrePaddingCount()
           
 ReportDataRow getReportDataRow()
           
 ResourceBundleFactory getResourceBundleFactory()
           
 boolean isAdvanceable()
           
 boolean isPrepareEventListener()
           
 GlobalMasterRow rebuild()
           
 void refresh()
           
 void resetDataSchema()
           
 MasterDataRow resetRowCursor()
           
 void setEnvironmentDataRow(ReportEnvironmentDataRow environmentDataRow)
           
 void setImportedDataRow(ImportedVariablesDataRow dataRow)
           
 void setParameterDataRow(ParameterDataRow parameterDataRow)
           
 void setReportDataRow(ReportDataRow reportDataRow)
           
 MasterDataRow startCrosstabMode(CrosstabSpecification crosstabSpecification)
           
 MasterDataRow updateDataSchema(DataSchemaDefinition dataSchemaDefinition)
           
 void updateImportedVariables(DataRow globalView, DataSchema dataSchema)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

createReportRow

public static GlobalMasterRow createReportRow(ProcessingContext reportContext,
                                              DataSchemaDefinition schemaDefinition,
                                              ParameterDataRow parameterDataRow,
                                              ParameterDefinitionEntry[] parameterDefinitionEntries,
                                              boolean includeStucturalProcessing)
Creates a new master-row. This is called only once when the report processing starts for the very first time.

Parameters:
reportContext -
schemaDefinition -
parameterDataRow -
Returns:

deriveSubDataRow

public MasterDataRow deriveSubDataRow(ProcessingContext reportContext,
                                      DataFactory reportFactory,
                                      ParameterDataRow parameterDataRow,
                                      ParameterDefinitionEntry[] parameterDefinitionEntries,
                                      ResourceBundleFactory resourceBundleFactory)
Specified by:
deriveSubDataRow in interface MasterDataRow

deriveWithQueryData

public MasterDataRow deriveWithQueryData(ReportDataRow tableData)
Specified by:
deriveWithQueryData in interface MasterDataRow

deriveWithReturnFromQuery

public MasterDataRow deriveWithReturnFromQuery()
Specified by:
deriveWithReturnFromQuery in interface MasterDataRow

getParameterDefinitionEntries

public ParameterDefinitionEntry[] getParameterDefinitionEntries()
Specified by:
getParameterDefinitionEntries in interface MasterDataRow

getDataFactory

public DataFactory getDataFactory()
Specified by:
getDataFactory in interface MasterDataRow

getDataSchema

public DataSchema getDataSchema()
Specified by:
getDataSchema in interface MasterDataRow

getReportDataRow

public ReportDataRow getReportDataRow()
Specified by:
getReportDataRow in interface MasterDataRow

setReportDataRow

public void setReportDataRow(ReportDataRow reportDataRow)

getExpressionDataRow

public ExpressionDataRow getExpressionDataRow()
Specified by:
getExpressionDataRow in interface MasterDataRow

getEnvironmentDataRow

public ReportEnvironmentDataRow getEnvironmentDataRow()

setEnvironmentDataRow

public void setEnvironmentDataRow(ReportEnvironmentDataRow environmentDataRow)

getParameterDataRow

public ParameterDataRow getParameterDataRow()
Specified by:
getParameterDataRow in interface MasterDataRow

setParameterDataRow

public void setParameterDataRow(ParameterDataRow parameterDataRow)

getGlobalView

public DataRow getGlobalView()
Specified by:
getGlobalView in interface MasterDataRow

dataRowChanged

public void dataRowChanged(MasterDataRowChangeEvent chEvent)
Specified by:
dataRowChanged in interface MasterDataRow

isAdvanceable

public boolean isAdvanceable()
Specified by:
isAdvanceable in interface MasterDataRow

derive

public MasterDataRow derive()
Specified by:
derive in interface MasterDataRow

setImportedDataRow

public void setImportedDataRow(ImportedVariablesDataRow dataRow)
Specified by:
setImportedDataRow in interface MasterDataRow

getImportedDataRow

public ImportedVariablesDataRow getImportedDataRow()
The datarow that contains the values as imported from the subreport. Can be null

Specified by:
getImportedDataRow in interface MasterDataRow
Returns:
the imported datarow.

getParentDataRow

public MasterDataRow getParentDataRow()
Specified by:
getParentDataRow in interface MasterDataRow

advance

public MasterDataRow advance()
This advances the cursor by one row and updates the flags.

Specified by:
advance in interface MasterDataRow
Returns:

advanceRecursively

public MasterDataRow advanceRecursively(boolean deepTraversingOnly,
                                        MasterDataRow subReportRow)
This method is public as a implementation sideeffect. It is only intended to be used internally and no matter what you intend: If you are not calling it from a MasterDataRow implementation, then you are on the wrong track.

Specified by:
advanceRecursively in interface MasterDataRow
Parameters:
deepTraversingOnly -
subReportRow -
Returns:

fireReportEvent

public void fireReportEvent(ReportEvent event)
Specified by:
fireReportEvent in interface MasterDataRow

updateImportedVariables

public void updateImportedVariables(DataRow globalView,
                                    DataSchema dataSchema)
Specified by:
updateImportedVariables in interface MasterDataRow

isPrepareEventListener

public boolean isPrepareEventListener()
Specified by:
isPrepareEventListener in interface MasterDataRow

startCrosstabMode

public MasterDataRow startCrosstabMode(CrosstabSpecification crosstabSpecification)
Specified by:
startCrosstabMode in interface MasterDataRow

endCrosstabMode

public MasterDataRow endCrosstabMode()
Specified by:
endCrosstabMode in interface MasterDataRow

resetRowCursor

public MasterDataRow resetRowCursor()
Specified by:
resetRowCursor in interface MasterDataRow

getPrePaddingCount

public int getPrePaddingCount()
Specified by:
getPrePaddingCount in interface MasterDataRow

clearExportedParameters

public MasterDataRow clearExportedParameters()
Specified by:
clearExportedParameters in interface MasterDataRow

getResourceBundleFactory

public ResourceBundleFactory getResourceBundleFactory()
Specified by:
getResourceBundleFactory in interface MasterDataRow

resetDataSchema

public void resetDataSchema()
Specified by:
resetDataSchema in interface MasterDataRow

rebuild

public GlobalMasterRow rebuild()
Specified by:
rebuild in interface MasterDataRow

updateDataSchema

public MasterDataRow updateDataSchema(DataSchemaDefinition dataSchemaDefinition)
Specified by:
updateDataSchema in interface MasterDataRow

getDataSchemaDefinition

public DataSchemaDefinition getDataSchemaDefinition()
Specified by:
getDataSchemaDefinition in interface MasterDataRow

refresh

public void refresh()
Specified by:
refresh in interface MasterDataRow