org.apache.maven.reporting
Class AbstractMavenReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

Direct Known Subclasses:

AbstractMavenMultiPageReport

public abstract class AbstractMavenReport
extends org.apache.maven.plugin.AbstractMojo
implements org.apache.maven.reporting.MavenReport

The basis for a Maven report which can be generated both as part of a site generation or as a direct standalone invocation.

Since:

2.0

Version:

$Id: AbstractMavenReport.java 942477 2010-05-08 22:53:23Z hboutemy $

Author:

Emmanuel Venisse

See Also:

execute(), generate(Sink, Locale), executeReport(Locale)

Field Summary

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

AbstractMavenReport()

Method Summary

boolean	canGenerateReport()
protected void	closeReport()
void	execute() This method is called when the report generation is invoked directly as a standalone Mojo.
protected abstract void	executeReport(java.util.Locale locale) Execute the generation of the report.
void	generate(org.codehaus.doxia.sink.Sink sink, java.util.Locale locale) This method is called when the report generation is invoked by maven-site-plugin.
java.lang.String	getCategoryName()
protected abstract java.lang.String	getOutputDirectory() The output directory when the mojo is run directly from the command line.
protected abstract org.apache.maven.project.MavenProject	getProject()
java.io.File	getReportOutputDirectory()
org.apache.maven.doxia.sink.Sink	getSink()
protected abstract org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
boolean	isExternalReport()
void	setReportOutputDirectory(java.io.File reportOutputDirectory)

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.reporting.MavenReport

getDescription, getName, getOutputName

Constructor Detail

AbstractMavenReport

public AbstractMavenReport()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

This method is called when the report generation is invoked directly as a standalone Mojo.

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException - if an error uccurs when generating the report

See Also:

org.apache.maven.plugins.site.ReportDocumentRender, Mojo.execute()

generate

public void generate(org.codehaus.doxia.sink.Sink sink,
                     java.util.Locale locale)
              throws org.apache.maven.reporting.MavenReportException

This method is called when the report generation is invoked by maven-site-plugin.

Specified by:

generate in interface org.apache.maven.reporting.MavenReport

Throws:

org.apache.maven.reporting.MavenReportException

See Also:

MavenReport.generate(org.codehaus.doxia.sink.Sink, java.util.Locale)

closeReport

protected void closeReport()

getCategoryName

public java.lang.String getCategoryName()

Specified by:

getCategoryName in interface org.apache.maven.reporting.MavenReport

getReportOutputDirectory

public java.io.File getReportOutputDirectory()

Specified by:

getReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

setReportOutputDirectory

public void setReportOutputDirectory(java.io.File reportOutputDirectory)

Specified by:

setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

getSink

public org.apache.maven.doxia.sink.Sink getSink()

Returns:

the sink used

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface org.apache.maven.reporting.MavenReport

Returns:

false by default.

See Also:

MavenReport.isExternalReport()

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport

getSiteRenderer

protected abstract org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Returns:

the site renderer used.

getOutputDirectory

protected abstract java.lang.String getOutputDirectory()

The output directory when the mojo is run directly from the command line. Implementors should use this method to return the value of a mojo parameter that the user may use to customize the output directory.
Note: When the mojo is run as part of a site generation, Maven will set the effective output directory via MavenReport.setReportOutputDirectory(java.io.File). In this case, the return value of this method is irrelevant. Therefore, developers should always call getReportOutputDirectory() to get the effective output directory for the report. The later method will eventually fallback to this method if the mojo is not run as part of a site generation.

Returns:

The path to the output directory as specified in the plugin configuration for this report.

getProject

protected abstract org.apache.maven.project.MavenProject getProject()

Returns:

the Maven project instance.

executeReport

protected abstract void executeReport(java.util.Locale locale)
                               throws org.apache.maven.reporting.MavenReportException

Execute the generation of the report.

Parameters:

locale - the wanted locale to return the report's description, could be null.

Throws:

MavenReportException - if any