planetj.database.report
Class OverallReportBreak

java.lang.Object
  planetj.database.report.ReportBreak
      planetj.database.report.OverallReportBreak

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class OverallReportBreak

extends ReportBreak

A special kind of ReportBreak which operates on all of the Rows returned by an SQL query, and not a subset of those Rows. This kind of ReportBreak does not have a BreakColumn, since it only appears after all of the data Rows in a RowCollection group.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.database.report.ReportBreak

ReportBreak.ReportBreakSpacingRow

Constructor Summary

OverallReportBreak()
OverallReportBreak default constructor

OverallReportBreak(ReportBreakCollection prbc, java.lang.String pColumnFunctionToken, java.util.List pFieldDescriptors)
Deprecated. Use the default constuctor instead

Method Summary

OverallReportBreak	getOverallReportBreak() Returns this same object
protected void	initialize(ReportBreakCollection prbc, java.lang.String pColumnFunctionToken, java.util.List pFieldNames) Initializes a ReportBreak.
boolean	isOverallReportBreak() This is an OverallReportBreak
protected void	setOverallReportBreak(OverallReportBreak pORB) Do not invoke this method

Methods inherited from class planetj.database.report.ReportBreak

clone, cloneReportBreak, equals, generateReport, generateReport, getBreakColumn, getColumnFunctions, getColumnFunctionToken, getFieldNames, getFieldNamesInternal, getIndex, getLastValue, getReportBreakCollection, getRows, hashCode, initialize, initialize, isAddReportBreakBefore, isGenerateReportForSingleRow, processRow, reset, setBreakColumn, setColumnFunctions, setFieldNames, setGenerateReportForSingleRow, setLastValue, setReportBreakCollection, setRows

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OverallReportBreak

public OverallReportBreak()

OverallReportBreak default constructor

OverallReportBreak

public OverallReportBreak(ReportBreakCollection prbc,
                          java.lang.String pColumnFunctionToken,
                          java.util.List pFieldDescriptors)
                   throws DataEngineException

Deprecated. Use the default constuctor instead

OverallReportBreak constructor

Parameters:

prbc - planetj.database.report.ReportBreakCollection

pColumnFunctionToken - java.lang.String

pFieldDescriptors - java.util.List

Throws:

DataEngineException - The exception description.

Method Detail

getOverallReportBreak

public OverallReportBreak getOverallReportBreak()

Returns this same object

Overrides:

getOverallReportBreak in class ReportBreak

initialize

protected void initialize(ReportBreakCollection prbc,
                          java.lang.String pColumnFunctionToken,
                          java.util.List pFieldNames)
                   throws DataEngineException

Initializes a ReportBreak. This method should be invoked before this ReportBreak is used

Throws:

DataEngineException

isOverallReportBreak

public boolean isOverallReportBreak()

This is an OverallReportBreak

Overrides:

isOverallReportBreak in class ReportBreak

setOverallReportBreak

protected void setOverallReportBreak(OverallReportBreak pORB)

Do not invoke this method

Overrides:

setOverallReportBreak in class ReportBreak