de.spieleck.app.jacson.report
Class CascadableReport

java.lang.Object
  de.spieleck.app.jacson.report.MultiReport
      de.spieleck.app.jacson.report.CascadableReport

All Implemented Interfaces:

JacsonPrintReport, JacsonReport, JacsonStately

public class CascadableReport

extends MultiReport

An report which dispatches a message to all contained (possible multiple) reports and one "parent Report".
This class might not be directly usable in applications, but is an important helper class to enable Jacson to act upon complete trees of Reports.

Author:

fsn

Field Summary

protected boolean	block Do we really want to cascade.
protected JacsonReport	parentReport Parent report in the cascade.

Fields inherited from class de.spieleck.app.jacson.report.MultiReport

reports

Constructor Summary

CascadableReport()

Method Summary

void	begin(java.lang.String id) Begin a subsection within report
void	end() Close a subsection within a report
void	finish(boolean close) Finish and optionally close the underlying resources
void	init(ConfigNode config) Initialize the report.
void	report(java.lang.String localName, java.lang.String value) Report a single name value pair within a report
void	setBlock(boolean block) Set the block
void	setSuperReport(JacsonReport parentReport) Hook a "parent"-Report.

Methods inherited from class de.spieleck.app.jacson.report.MultiReport

addReport, clear, countReports, finish, getRegState, registerState, setOutputStream, setPrintWriter

Methods inherited from class java.lang.Object

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

Field Detail

parentReport

protected JacsonReport parentReport

Parent report in the cascade.

block

protected boolean block

Do we really want to cascade.

Constructor Detail

CascadableReport

public CascadableReport()

Method Detail

setBlock

public void setBlock(boolean block)

Set the block

setSuperReport

public void setSuperReport(JacsonReport parentReport)

Hook a "parent"-Report.

init

public void init(ConfigNode config)
          throws JacsonConfigException

Description copied from interface: JacsonReport

Initialize the report. The passed ConfigNode can be used to obtain configuration information of the report from the global config xml.

Specified by:

init in interface JacsonReport

Overrides:

init in class MultiReport

Throws:

JacsonConfigException

finish

public void finish(boolean close)

Description copied from interface: JacsonReport

Finish and optionally close the underlying resources

Specified by:

finish in interface JacsonReport

Overrides:

finish in class MultiReport

begin

public void begin(java.lang.String id)

Description copied from interface: JacsonReport

Begin a subsection within report

Specified by:

begin in interface JacsonReport

Overrides:

begin in class MultiReport

report

public void report(java.lang.String localName,
                   java.lang.String value)

Description copied from interface: JacsonReport

Report a single name value pair within a report

Specified by:

report in interface JacsonReport

Overrides:

report in class MultiReport

end

public void end()

Description copied from interface: JacsonReport

Close a subsection within a report

Specified by:

end in interface JacsonReport

Overrides:

end in class MultiReport