com.wakaleo.schemaspy
Class SchemaSpyReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          com.wakaleo.schemaspy.SchemaSpyReport

All Implemented Interfaces:

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

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

The SchemaSpy Maven plugin report.

Author:

John Smart

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

SchemaSpyReport()

Method Summary

protected void	executeReport(Locale locale) Generate the Schemaspy report.
String	getDescription(Locale arg0)
String	getName(Locale arg0)
protected String	getOutputDirectory()
String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
boolean	isExternalReport() Always return true as we're using the report generated by SchemaSpy rather than creating our own report.

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

canGenerateReport, 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

Constructor Detail

SchemaSpyReport

public SchemaSpyReport()

Method Detail

executeReport

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

Generate the Schemaspy report.

Specified by:

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

Parameters:

locale - the language of the report - currently ignored.

Throws:

org.apache.maven.reporting.MavenReportException - if schemaspy crashes

getOutputDirectory

protected String getOutputDirectory()

Specified by:

getOutputDirectory 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

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Specified by:

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

getDescription

public String getDescription(Locale arg0)

getName

public String getName(Locale arg0)

getOutputName

public String getOutputName()

isExternalReport

public boolean isExternalReport()

Always return true as we're using the report generated by SchemaSpy rather than creating our own report.

Specified by:

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

Overrides:

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

Returns:

true