org.apache.maven.plugin.jxr
Class AbstractJxrReport

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.reporting.AbstractMavenReport
          extended by org.apache.maven.plugin.jxr.AbstractJxrReport
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport
Direct Known Subclasses:
JxrReport, JxrTestReport

public abstract class AbstractJxrReport
extends org.apache.maven.reporting.AbstractMavenReport

Base class for the JXR reports.

Author:
Fabrice Bellingard, Brett Porter

Field Summary
protected  boolean aggregate
          Whether to build an aggregated report at the root, or build individual reports.
protected  List reactorProjects
          The projects in the reactor for aggregation report.
 
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
AbstractJxrReport()
           
 
Method Summary
 boolean canGenerateReport()
           
protected  boolean canGenerateReport(List sourceDirs)
           
protected  List constructSourceDirs()
           
protected  void executeReport(Locale locale)
          Cf.
protected  ResourceBundle getBundle(Locale locale)
          Returns the correct resource bundle according to the locale
protected abstract  String getDestinationDirectory()
           
protected abstract  String getJavadocLocation()
           
protected  String getOutputDirectory()
          Cf.
 org.apache.maven.project.MavenProject getProject()
          Cf.
protected  org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
          Cf.
protected abstract  List getSourceRoots()
           
protected abstract  List getSourceRoots(org.apache.maven.project.MavenProject project)
           
protected  void init()
          Initialize some attributes required during the report generation
 boolean isExternalReport()
           
protected  List pruneSourceDirs(List sourceDirs)
           
 
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, 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
 
Methods inherited from interface org.apache.maven.reporting.MavenReport
getDescription, getName, getOutputName
 

Field Detail

reactorProjects

protected List reactorProjects
The projects in the reactor for aggregation report.


aggregate

protected boolean aggregate
Whether to build an aggregated report at the root, or build individual reports.

Constructor Detail

AbstractJxrReport

public AbstractJxrReport()
Method Detail

pruneSourceDirs

protected List pruneSourceDirs(List sourceDirs)

init

protected void init()
Initialize some attributes required during the report generation


getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
Cf. overriden method documentation.

Specified by:
getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport
See Also:
AbstractMavenReport.getSiteRenderer()

getOutputDirectory

protected String getOutputDirectory()
Cf. overriden method documentation.

Specified by:
getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport
See Also:
AbstractMavenReport.getOutputDirectory()

getProject

public org.apache.maven.project.MavenProject getProject()
Cf. overriden method documentation.

Specified by:
getProject in class org.apache.maven.reporting.AbstractMavenReport
See Also:
AbstractMavenReport.getProject()

getBundle

protected ResourceBundle getBundle(Locale locale)
Returns the correct resource bundle according to the locale

Parameters:
locale - : the locale of the user
Returns:
the bundle correponding to the locale

canGenerateReport

protected boolean canGenerateReport(List sourceDirs)

executeReport

protected void executeReport(Locale locale)
                      throws org.apache.maven.reporting.MavenReportException
Cf. overriden method documentation.

Specified by:
executeReport in class org.apache.maven.reporting.AbstractMavenReport
Throws:
org.apache.maven.reporting.MavenReportException
See Also:
AbstractMavenReport.executeReport(java.util.Locale)

constructSourceDirs

protected List constructSourceDirs()

canGenerateReport

public boolean canGenerateReport()
Specified by:
canGenerateReport in interface org.apache.maven.reporting.MavenReport
Overrides:
canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport

isExternalReport

public boolean isExternalReport()
Specified by:
isExternalReport in interface org.apache.maven.reporting.MavenReport
Overrides:
isExternalReport in class org.apache.maven.reporting.AbstractMavenReport

getDestinationDirectory

protected abstract String getDestinationDirectory()

getSourceRoots

protected abstract List getSourceRoots()

getSourceRoots

protected abstract List getSourceRoots(org.apache.maven.project.MavenProject project)

getJavadocLocation

protected abstract String getJavadocLocation()


Copyright © 2005-2012 Apache Software Foundation. All Rights Reserved.