de.smartics.testdoc.maven
Class AbstractSourceReportMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          de.smartics.testdoc.maven.AbstractReportMojo
              de.smartics.testdoc.maven.AbstractSourceReportMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

TestDocReportMojo

public abstract class AbstractSourceReportMojo
     
     

      
      extends 
      
      AbstractReportMojo
     
     

The abstract base implementation for reports.

Author:

Robert Reiner

Field Summary

protected File	coberturaLocation The location of the Cobertura test report to reference.
protected ImageHelper	imageHelper Configuration of links to images used in reports.
protected File	javadocLocation The location of the Javadoc report to reference.
protected File	javadocTestLocation The location of the Javadoc test report to reference.
protected JUnitTestCaseManager	junitManager The manager to access JUnit report information.
protected File	junitReportLocation The location of the JavaDoc report to reference.
protected boolean	linkCobertura Controls whether to reference the Cobertura test report when found.
protected boolean	linkJavadoc Controls whether to reference the Javadoc report when found.
protected boolean	linkJavadocTest Controls whether to reference the Javadoc test report when found.
protected boolean	linkSurefire Controls whether to reference the javadoc report when found.
protected boolean	linkXref Controls whether to reference the source code report (XRef) when found.
protected boolean	linkXrefTest Controls whether to reference the source code report (XRef) when found.
protected boolean	presentJUnitReport Controls whether to show test case information read from the JUnit XML reports.
protected ExternalReportReferences	reports Helper to construct links to external reports.
protected File	surefireLocation The location of the JavaDoc report to reference.
protected File	xrefLocation The location of the source code report (XRef) to reference.
protected File	xrefTestLocation The location of the source code report (XRef) to reference.

Fields inherited from class de.smartics.testdoc.maven.AbstractReportMojo

description, factory, locale, localRepository, logLevel, messages, name, outputDirectory, outputName, project, resolver, siteRenderer

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

AbstractSourceReportMojo()

Method Summary

protected de.smartics.maven.util.report.link.LinkConstructorStrategy	createStrategy(String reportArtifactId, File location, boolean linkToMember, String labelKey)
protected void	executeReport(Locale locale) Configures the plugin logger.

Methods inherited from class de.smartics.testdoc.maven.AbstractReportMojo

canGenerateReport, execute, getBundle, getDescription, getName, getOutputDirectory, getOutputName, getProject, getSiteRenderer

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

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

xrefLocation

protected File xrefLocation

The location of the source code report (XRef) to reference.

linkXref

protected boolean linkXref

Controls whether to reference the source code report (XRef) when found.

linkJavadoc

protected boolean linkJavadoc

Controls whether to reference the Javadoc report when found.

javadocLocation

protected File javadocLocation

The location of the Javadoc report to reference.

xrefTestLocation

protected File xrefTestLocation

The location of the source code report (XRef) to reference.

linkXrefTest

protected boolean linkXrefTest

Controls whether to reference the source code report (XRef) when found.

linkJavadocTest

protected boolean linkJavadocTest

Controls whether to reference the Javadoc test report when found.

javadocTestLocation

protected File javadocTestLocation

The location of the Javadoc test report to reference.

linkSurefire

protected boolean linkSurefire

Controls whether to reference the javadoc report when found.

surefireLocation

protected File surefireLocation

The location of the JavaDoc report to reference.

presentJUnitReport

protected boolean presentJUnitReport

Controls whether to show test case information read from the JUnit XML reports.

junitReportLocation

protected File junitReportLocation

The location of the JavaDoc report to reference.

linkCobertura

protected boolean linkCobertura

Controls whether to reference the Cobertura test report when found.

coberturaLocation

protected File coberturaLocation

The location of the Cobertura test report to reference.

reports

protected ExternalReportReferences reports

Helper to construct links to external reports.

junitManager

protected JUnitTestCaseManager junitManager

The manager to access JUnit report information. Is null if the information is not to be included.

imageHelper

protected ImageHelper imageHelper

Configuration of links to images used in reports.

Constructor Detail

AbstractSourceReportMojo

public AbstractSourceReportMojo()

Method Detail

executeReport

protected void executeReport(Locale locale)
                      throws MavenReportException

Configures the plugin logger.

Configures the plugin logger.

Overrides:

executeReport in class AbstractReportMojo

Throws:

MavenReportException

See Also:

AbstractMavenReport.executeReport(java.util.Locale)

createStrategy

protected de.smartics.maven.util.report.link.LinkConstructorStrategy createStrategy(String reportArtifactId,
                                                                                    File location,
                                                                                    boolean linkToMember,
                                                                                    String labelKey)
                                                                             throws MavenReportException

Throws:

MavenReportException