net.logAnalyzer.reports
Class TXTReportRenderer

java.lang.Object
  net.logAnalyzer.reports.TXTReportRenderer

All Implemented Interfaces:

LAReportRenderer

public class TXTReportRenderer

extends java.lang.Object

implements LAReportRenderer

Generates TXT reports from analyzers results. Each analysis is serialized in a textual tabulated format according to the class of its result.

Each report returned by render() is a String wrapped in a TXTReport.

Version:

0.1

Author:

Karim REFEYTON

Field Summary

static char

DEFAULT_DELIMITER Default delimiter (tabulation).

Constructor Summary

TXTReportRenderer(RendererDefinition definition, LAAnalyzer[] analyzers)
Creates a new report for each specified analyzer.

Method Summary

java.lang.String	getName() Returns the name of the analyzer.
LAReport[]	render() Renders the reports.
LAReport[]	render(char delimiter) Renders the report.
protected java.lang.String	renderAnalyze(char delimiter, LAAnalysis analysis) Empty method to avoid loops on unsupported analysis.
protected java.lang.String	renderAnalyze(char delimiter, MultiValuesAnalysis analysis) Renders a multi values result in a file called [analyzername].
protected java.lang.String	renderAnalyze(char delimiter, SingleValueAnalysis analysis) Renders a key values result in a file called [analyzername].

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DELIMITER

public static final char DEFAULT_DELIMITER

Default delimiter (tabulation).

See Also:

Constant Field Values

Constructor Detail

TXTReportRenderer

public TXTReportRenderer(RendererDefinition definition,
                         LAAnalyzer[] analyzers)

Creates a new report for each specified analyzer.

Parameters:

definition - Renderer definition.

analyzers - Analyzers to report.

Method Detail

getName

public java.lang.String getName()

Returns the name of the analyzer.

Specified by:

getName in interface LAReportRenderer

Returns:

LAAnalyzer name.

See Also:

LAReportRenderer.getName()

render

public LAReport[] render()
                  throws ReportException

Renders the reports. Each report is a TXTReport wrapping a String containing a textual tabulated representation of an analyzer result.
Uses the default delimiter DEFAULT_DELIMITER.

Specified by:

render in interface LAReportRenderer

Returns:

Generated reports.

Throws:

ReportException

See Also:

LAReportRenderer.render()

render

public LAReport[] render(char delimiter)
                  throws ReportException

Renders the report. Uses the specified delimiter.

Parameters:

delimiter - Field delimiter.

Returns:

Generated reports.

Throws:

ReportException

renderAnalyze

protected java.lang.String renderAnalyze(char delimiter,
                                         LAAnalysis analysis)

Empty method to avoid loops on unsupported analysis.

Parameters:

delimiter - Field delimiter.

analysis - Analysis to render.

Returns:

String report.

renderAnalyze

protected java.lang.String renderAnalyze(char delimiter,
                                         SingleValueAnalysis analysis)

Renders a key values result in a file called [analyzername]. File format :

key	{delimiter}	valueName
key[1]	{delimiter}	value[1]
key[2]	{delimiter}	value[2]
...	{delimiter}	...

Parameters:

delimiter - Field delimiter.

analysis - Analysis to render.

Returns:

String report.

renderAnalyze

protected java.lang.String renderAnalyze(char delimiter,
                                         MultiValuesAnalysis analysis)

Renders a multi values result in a file called [analyzername]. File format :

key	{delimiter}	valueName1	{delimiter}	valueName2	{delimiter}	...
key[1]	{delimiter}	value1[1]	{delimiter}	value2[1]	{delimiter}	...
key[2]	{delimiter}	value1[2]	{delimiter}	value2[1]	{delimiter}	...
...	{delimiter}	...	{delimiter}	...	{delimiter}	...

Parameters:

delimiter - Field delimiter.

analysis - Analysis to render.

Returns:

String report.