org.jdave.maven.report
Class JDaveReportMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.jdave.maven.report.JDaveReportMojo

All Implemented Interfaces:

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

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

Author:

Joni Freeman

Field Summary

protected String	outputDirectory Location where generated html will be created.
protected org.apache.maven.project.MavenProject	project Maven Project
protected File	reportsDirectory Directory of raw XML files.
protected org.codehaus.doxia.site.renderer.SiteRenderer	siteRenderer Doxia Site Renderer
protected File	xrefLocation Location of the Xrefs to link.

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

JDaveReportMojo()

Method Summary

boolean	canGenerateReport()
protected void	executeReport(Locale locale)
String	getDescription(Locale locale)
String	getName(Locale locale)
protected String	getOutputDirectory()
String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
protected org.codehaus.doxia.site.renderer.SiteRenderer	getSiteRenderer()

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

closeReport, execute, generate, getCategoryName, getReportOutputDirectory, getSink, isExternalReport, 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

Field Detail

outputDirectory

protected String outputDirectory

Location where generated html will be created.

siteRenderer

protected org.codehaus.doxia.site.renderer.SiteRenderer siteRenderer

Doxia Site Renderer

project

protected org.apache.maven.project.MavenProject project

Maven Project

reportsDirectory

protected File reportsDirectory

Directory of raw XML files.

xrefLocation

protected File xrefLocation

Location of the Xrefs to link.

Constructor Detail

JDaveReportMojo

public JDaveReportMojo()

Method Detail

executeReport

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

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)

getSiteRenderer

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

Specified by:

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

getProject

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

Specified by:

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

getOutputName

public String getOutputName()

getOutputDirectory

protected String getOutputDirectory()

Specified by:

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

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

Overrides:

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