org.codehaus.mojo.dashboard.report.plugin
Class DashBoardReportMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.codehaus.mojo.dashboard.report.plugin.DashBoardReportMojo

All Implemented Interfaces:

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

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

A Dashboard report which aggregates all other report results.

Author:

David Vicente

Field Summary

protected java.lang.String	connectionUrl Hibernate connection URL
protected java.lang.String	dashboardDataFile The generated DashBoard report Datafile.
protected java.lang.String	dialect Hibernate dialect
protected java.lang.String	driverClass Hibernate driver class
protected HibernateService	hibernateService Hibernate Service
protected boolean	isPropHibernateSet
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository The local repository.
protected org.apache.maven.project.MavenProjectBuilder	mavenProjectBuilder Project builder
protected java.lang.String	password Hibernate database password
protected java.lang.String	username Hibernate database username

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

DashBoardReportMojo()

Method Summary

boolean	canGenerateReport()
protected void	configureHibernateDriver()
protected void	executeReport(java.util.Locale arg0)
java.util.ResourceBundle	getBundle(java.util.Locale locale)
java.lang.String	getDescription(java.util.Locale locale)
java.lang.String	getName(java.util.Locale locale)
protected java.lang.String	getOutputDirectory()
java.lang.String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
protected boolean	isDBAvailable()
boolean	usePageLinkBar()

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

closeReport, execute, generate, generate, generate, getCategoryName, 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

Field Detail

dashboardDataFile

protected java.lang.String dashboardDataFile

The generated DashBoard report Datafile.

localRepository

protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

The local repository.

mavenProjectBuilder

protected org.apache.maven.project.MavenProjectBuilder mavenProjectBuilder

Project builder

hibernateService

protected HibernateService hibernateService

Hibernate Service

dialect

protected java.lang.String dialect

Hibernate dialect

driverClass

protected java.lang.String driverClass

Hibernate driver class

connectionUrl

protected java.lang.String connectionUrl

Hibernate connection URL

username

protected java.lang.String username

Hibernate database username

password

protected java.lang.String password

Hibernate database password

isPropHibernateSet

protected boolean isPropHibernateSet

Constructor Detail

DashBoardReportMojo

public DashBoardReportMojo()

Method Detail

executeReport

protected void executeReport(java.util.Locale arg0)
                      throws org.apache.maven.reporting.MavenReportException

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

getOutputDirectory

protected java.lang.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 java.lang.String getDescription(java.util.Locale locale)

getName

public java.lang.String getName(java.util.Locale locale)

getOutputName

public java.lang.String getOutputName()

getBundle

public java.util.ResourceBundle getBundle(java.util.Locale locale)

usePageLinkBar

public boolean usePageLinkBar()

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

Overrides:

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

configureHibernateDriver

protected void configureHibernateDriver()

isDBAvailable

protected boolean isDBAvailable()