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
The SchemaSpy Maven plugin report.
- Author:
- John Smart The SchemaSpy Maven plugin This plugin is designed to generate SchemaSpy reports for a Maven web site. SchemaSpy (http://schemaspy.sourceforge.net) does not need to be installed and accessible on your machine. However, SchemaSpy also needs the Graphviz tool (http://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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
Whether to create the report only on the execution root of a multi-module project.protected boolean
Fields inherited from class org.apache.maven.reporting.AbstractMavenReport
localRepository, remoteRepositories, siteTool
Fields inherited from interface org.apache.maven.reporting.MavenReport
CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
protected void
executeReport
(Locale locale) Generate the Schemaspy report.getDescription
(Locale locale) protected String
protected MavenProject
protected org.apache.maven.doxia.siterenderer.Renderer
boolean
Always returntrue
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, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, setReportOutputDirectory
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Field Details
-
vizjs
-
runOnExecutionRoot
@Parameter(property="runOnExecutionRoot", defaultValue="false") protected boolean runOnExecutionRootWhether 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
-
executeReport
Generate the Schemaspy report.- Specified by:
executeReport
in classAbstractMavenReport
- Parameters:
locale
- the language of the report - currently ignored.- Throws:
MavenReportException
- if schemaspy crashes
-
canGenerateReport
public boolean canGenerateReport()- Specified by:
canGenerateReport
in interfaceMavenReport
- Overrides:
canGenerateReport
in classAbstractMavenReport
-
getOutputDirectory
- Overrides:
getOutputDirectory
in classAbstractMavenReport
-
getProject
- Overrides:
getProject
in classAbstractMavenReport
-
getSiteRenderer
protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()- Overrides:
getSiteRenderer
in classAbstractMavenReport
-
getDescription
-
getName
-
getOutputName
-
isExternalReport
public boolean isExternalReport()Always returntrue
as we're using the report generated by SchemaSpy rather than creating our own report.- Specified by:
isExternalReport
in interfaceMavenReport
- Overrides:
isExternalReport
in classAbstractMavenReport
- Returns:
true
-