Package org.mybatis.maven.mvnmigrate.report

Class StatusCommandReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.mybatis.maven.mvnmigrate.report.StatusCommandReportMojo

All Implemented Interfaces:

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

@Mojo(name="status-report")
public final class StatusCommandReportMojo
extends org.apache.maven.reporting.AbstractMavenReport

Extends AbstractMavenReport.
Class to generate a Maven report.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	aggregate	Aggregate report results.
protected String	environment	Environment to configure.
protected boolean	force	Forces script to continue even if SQL errors are encountered.
protected List<org.apache.maven.project.MavenProject>	reactorProjects	The projects in the reactor for aggregation report.
protected File	repository	Location of migrate repository.
protected boolean	skip	Skip migration actions.

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

locale, mojoExecution, outputFormat, outputTimestamp, remoteProjectRepositories, repoSession, siteDirectory, 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
StatusCommandReportMojo()

Method Summary

Modifier and Type	Method	Description
protected void	executeReport(Locale locale)
protected ResourceBundle	getBundle(Locale locale)	Return the ResourceBundle given the current locale.
String	getDescription(Locale locale)	Return the description of the report.
String	getName(Locale locale)	Return the name of the report.
protected String	getOutputDirectory()
String	getOutputName()	Return the output name of the report.
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()

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

canGenerateReport, closeReport, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputEncoding, 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

Methods inherited from interface org.apache.maven.reporting.MavenReport

getOutputPath

Field Details

reactorProjects

@Parameter(property="reactorProjects",
           readonly=true)
protected List<org.apache.maven.project.MavenProject> reactorProjects

The projects in the reactor for aggregation report.

repository

@Parameter(property="migration.path",
           defaultValue=".")
protected File repository

Location of migrate repository.

environment

@Parameter(property="migration.env",
           defaultValue="development")
protected String environment

Environment to configure. Default environment is 'development'.

force

@Parameter(property="migration.force",
           defaultValue="false")
protected boolean force

Forces script to continue even if SQL errors are encountered.

skip

@Parameter(property="migration.skip",
           defaultValue="false")
protected boolean skip

Skip migration actions.

aggregate

@Parameter(property="migration.aggregate",
           defaultValue="false")
protected boolean aggregate

Aggregate report results.

Constructor Details

StatusCommandReportMojo

public StatusCommandReportMojo()

Method Details

executeReport

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

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

getOutputDirectory

protected String getOutputDirectory()

Overrides:

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

getProject

protected org.apache.maven.project.MavenProject getProject()

Overrides:

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

getSiteRenderer

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

Overrides:

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

getOutputName

public String getOutputName()

Return the output name of the report.

Returns:

the output name.

getName

public String getName(Locale locale)

Return the name of the report.

Returns:

the name of the report.

getDescription

public String getDescription(Locale locale)

Return the description of the report.

Returns:

the description of the report.

getBundle

protected ResourceBundle getBundle(Locale locale)

Return the ResourceBundle given the current locale.

Parameters:

locale - the current locale.