de.spieleck.app.jacson
Interface JacsonReport

All Superinterfaces:

JacsonStately

All Known Subinterfaces:

JacsonPrintReport

All Known Implementing Classes:

Log4jReport, MultiReport, PrintingReport, XSLTReport

public interface JacsonReport

extends JacsonStately

A Report, that is something that takes certain events and know where to put it. This was kind of inspired of SAX(1) and is a very tiny event API. The intelligence has to be in the implementation underneath.
Reports distributed with Jacson reside in the de.spieleck.app.jacson.report package.
The lifecycle of a report is documented elsewhere. In short it is:

• one init() event
• one begin() event
• arbitrary many begin()/end() events, properly nested, mixed with everywhere within these report() events
• one finish() event

Author:

fsn, Patrick Carl

Method Summary

void	begin(java.lang.String id) Begin a subsection within report
void	end() Close a subsection within a report
void	finish() Finish and close underlying resources
void	finish(boolean close) Finish and optionally close the underlying resources
JacsonState	getRegState() returns the set JacsonState
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

Methods inherited from interface de.spieleck.app.jacson.JacsonStately

registerState

Method Detail

init

public void init(ConfigNode config)
          throws JacsonConfigException

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

Throws:

JacsonConfigException

finish

public void finish()

Finish and close underlying resources

finish

public void finish(boolean close)

Finish and optionally close the underlying resources

Parameters:

close - flag whether to close resources or not.

begin

public void begin(java.lang.String id)

Begin a subsection within report

report

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

Report a single name value pair within a report

end

public void end()

Close a subsection within a report

getRegState

public JacsonState getRegState()

returns the set JacsonState