net.sf.yal10n.report

Class ReportRenderer

java.lang.Object

net.sf.yal10n.report.ReportRenderer

@Component(role=ReportRenderer.class,
           hint="ReportRenderer")
public class ReportRenderer
extends Object

The report renderer creates a html report of single file with velocity.

Constructor Summary

Constructors

Constructor and Description
ReportRenderer()

Method Summary

Methods

Modifier and Type	Method and Description
String	getReportDirectory() Gets the directory path the is used for the report output directory.
boolean	prepareOutputDirectory(String outputDirectory) Makes sure the report output directory exists.
void	render(ReportModel model, String outputDirectory) Renders the given report model.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportRenderer

public ReportRenderer()

Method Detail

render

public void render(ReportModel model,
          String outputDirectory)

Renders the given report model.

Parameters:

model - the report to render.

outputDirectory - the output directory

prepareOutputDirectory

public boolean prepareOutputDirectory(String outputDirectory)

Makes sure the report output directory exists.

Parameters:

outputDirectory - the output directory

Returns:

true if the output report directory exists and is usable, false otherwise. Problem could be, that the directory couldn't be created or the reportDirectory is not a directory.

See Also:

getReportDirectory()

getReportDirectory

public String getReportDirectory()

Gets the directory path the is used for the report output directory.

Returns:

the report output directory.