org.apache.maven.reporting
Class AbstractMavenReport

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.reporting.AbstractMavenReport
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

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

The basis for a Maven report.

Since:
2.0
Version:
$Id: AbstractMavenReport.java 580580 2007-09-29 13:09:28Z vsiveton $
Author:
Emmanuel Venisse

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()
          Actions when closing the report.
 void execute()
          This method should be never called - all reports are rendered by Maven site-plugin's
protected abstract  void executeReport(java.util.Locale locale)
          Execute the generation of the report.
 void generate(org.codehaus.doxia.sink.Sink aSink, java.util.Locale aLocale)
          Deprecated. using generate(Sink, SinkFactory, Locale) instead of
 void generate(org.apache.maven.doxia.sink.Sink aSink, java.util.Locale aLocale)
          Deprecated. using generate(Sink, SinkFactory, Locale) instead of
 void generate(org.apache.maven.doxia.sink.Sink aSink, org.apache.maven.doxia.sink.SinkFactory aSinkFactory, java.util.Locale aLocale)
          Generate a report.
 java.lang.String getCategoryName()
          
protected abstract  java.lang.String getOutputDirectory()
           
protected abstract  org.apache.maven.project.MavenProject getProject()
           
 java.io.File getReportOutputDirectory()
          
 org.apache.maven.doxia.sink.Sink getSink()
           
 org.apache.maven.doxia.sink.SinkFactory getSinkFactory()
           
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 should be never called - all reports are rendered by Maven site-plugin's

Specified by:
execute in interface org.apache.maven.plugin.Mojo
Throws:
org.apache.maven.plugin.MojoExecutionException
See Also:
org.apache.maven.plugins.site.ReportDocumentRender, Mojo.execute()

generate

public void generate(org.codehaus.doxia.sink.Sink aSink,
                     java.util.Locale aLocale)
              throws org.apache.maven.reporting.MavenReportException
Deprecated. using generate(Sink, SinkFactory, Locale) instead of

Generate a report.

Parameters:
aSink - the sink to use for the generation.
aLocale - the wanted locale to generate the report, could be null.
Throws:
MavenReportException - if any

generate

public void generate(org.apache.maven.doxia.sink.Sink aSink,
                     java.util.Locale aLocale)
              throws org.apache.maven.reporting.MavenReportException
Deprecated. using generate(Sink, SinkFactory, Locale) instead of

Generate a report.

Specified by:
generate in interface org.apache.maven.reporting.MavenReport
Throws:
org.apache.maven.reporting.MavenReportException
See Also:
MavenReport.generate(org.apache.maven.doxia.sink.Sink, java.util.Locale)

generate

public void generate(org.apache.maven.doxia.sink.Sink aSink,
                     org.apache.maven.doxia.sink.SinkFactory aSinkFactory,
                     java.util.Locale aLocale)
              throws org.apache.maven.reporting.MavenReportException
Generate a report.

Parameters:
aSink -
aSinkFactory -
aLocale -
Throws:
MavenReportException

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

closeReport

protected void closeReport()
Actions when closing the report. By default, nothing to do.


getSink

public org.apache.maven.doxia.sink.Sink getSink()
Returns:
the sink used

getSinkFactory

public org.apache.maven.doxia.sink.SinkFactory getSinkFactory()
Returns:
the sink factory 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()
Returns:
the output directory path.

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


Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.