net.objectlab.qalab.m2.report
Class MainReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          net.objectlab.qalab.m2.report.MainReport

All Implemented Interfaces:

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

public class MainReport
extends org.apache.maven.reporting.AbstractMavenReport

Goal that handles the generation of a site report based on the data in the qalab.xml file.

Author:

Dave Sag and Benoit Xhenseval.

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

MainReport()

Method Summary

protected void	executeReport(java.util.Locale aLocale) generate the actual report.
java.lang.String	getDescription(java.util.Locale aLocale)
java.lang.String	getName(java.util.Locale aLocale)
protected java.lang.String	getOutputDirectory()
java.lang.String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
protected org.codehaus.doxia.site.renderer.SiteRenderer	getSiteRenderer()
boolean	isExternalReport()

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

canGenerateReport, closeReport, execute, generate, getCategoryName, getReportOutputDirectory, getSink, setReportOutputDirectory

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

Constructor Detail

MainReport

public MainReport()

Method Detail

executeReport

protected final void executeReport(java.util.Locale aLocale)
                            throws org.apache.maven.reporting.MavenReportException

generate the actual report.

Specified by:

executeReport in class org.apache.maven.reporting.AbstractMavenReport

Parameters:

aLocale - ignored.

Throws:

org.apache.maven.reporting.MavenReportException - if anything goes wrong.

getOutputName

public final java.lang.String getOutputName()

Returns:

"qalab/index"

See Also:

MavenReport.getOutputName()

getOutputDirectory

protected final java.lang.String getOutputDirectory()

Specified by:

getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

Returns:

The output directory as configured in your pom.xml.

See Also:

AbstractMavenReport.getOutputDirectory()

getProject

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

Specified by:

getProject in class org.apache.maven.reporting.AbstractMavenReport

Returns:

The Maven Project itself. Used internally to get access to Config params etc.

See Also:

AbstractMavenReport.getProject()

getSiteRenderer

protected final org.codehaus.doxia.site.renderer.SiteRenderer getSiteRenderer()

Specified by:

getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport

Returns:

a direct reference to the site renderer.

See Also:

AbstractMavenReport.getSiteRenderer()

getName

public final java.lang.String getName(java.util.Locale aLocale)

Parameters:

aLocale - The locale.

Returns:

The locale specific report name.

See Also:

MavenReport.getName(java.util.Locale)

getDescription

public final java.lang.String getDescription(java.util.Locale aLocale)

Parameters:

aLocale - The locale.

Returns:

The locale specific report description.

See Also:

MavenReport.getDescription(java.util.Locale)

isExternalReport

public final boolean isExternalReport()

Specified by:

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

Overrides:

isExternalReport in class org.apache.maven.reporting.AbstractMavenReport

Returns:

true.

See Also:

MavenReport.isExternalReport()