Package 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:

ContextEnabled, Mojo, MavenMultiPageReport, MavenReport

@Mojo(name="schemaspy",
      defaultPhase=SITE)
public class SchemaSpyReport
extends AbstractMavenReport

The SchemaSpy Maven plugin report.

This plugin is designed to generate SchemaSpy report for a Maven website. SchemaSpy also may need the Graphviz tool (https://www.graphviz.org/) in order to generate graphical representations of the table/view relationships, so this needs to be installed on your machine.

The schemaspy goal invokes the SchemaSpy command-line tool. SchemaSpy generates a graphical and HTML report describing a given relational database.

Author:

John Smart, mprins

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	runOnExecutionRoot	Whether to create the report only on the execution root of a multi-module project.
protected boolean	vizjs

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

locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, siteRenderer, siteTool

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

Constructors

Constructor	Description
SchemaSpyReport()

Method Summary

Modifier and Type	Method	Description
boolean	canGenerateReport()
protected void	executeReport(Locale locale)	Generate the Schemaspy report.
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()
String	getOutputPath()
boolean	isExternalReport()	Always return true as we're using the report generated by SchemaSpy rather than creating our own report.
protected void	setSchemaAnalyzer(MavenSchemaAnalyzer analyzer)

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

closeReport, constructXrefLocation, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputDirectory, getOutputEncoding, getProject, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, getXrefLocation, 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 Details

vizjs

@Parameter(property="vizjs",
           defaultValue="true")
protected boolean vizjs

runOnExecutionRoot

@Parameter(property="runOnExecutionRoot",
           defaultValue="false")
protected boolean runOnExecutionRoot

Whether to create the report only on the execution root of a multi-module project.

Since:

5.0.4

Constructor Details

SchemaSpyReport

public SchemaSpyReport()

Method Details

setSchemaAnalyzer

protected void setSchemaAnalyzer(MavenSchemaAnalyzer analyzer)

executeReport

protected void executeReport(Locale locale)
                      throws MavenReportException

Generate the Schemaspy report.

Specified by:

executeReport in class AbstractMavenReport

Parameters:

locale - the language of the report — currently ignored.

Throws:

MavenReportException - if schemaspy crashes

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface MavenReport

Overrides:

canGenerateReport in class AbstractMavenReport

getDescription

public String getDescription(Locale locale)

getName

public String getName(Locale locale)

getOutputName

public String getOutputName()

getOutputPath

public String getOutputPath()

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 MavenReport

Overrides:

isExternalReport in class AbstractMavenReport

Returns:

true