dashboard:dashboard

This is the main goal of the dashboard plugin. It reads in an XHTML table and adds the dashboard report table to it.

Mojo Attributes :

  • Requires a Maven 2.0 project to execute.
  • Executes as an aggregator plugin.

Required Parameters

Name Type Description
destinationFile File The name of the file where the dashboard is generated into.
xpathToDestinationNode String The xpath expression of node in the destinationFile where the dashboard table will be generated in. A section will be added to this node, containing a table with the statistics.

Optional Parameters

Name Type Description
columns Map The columns to generate per report. This is a mapping from report (by report alias or full class name) to comma separated column indexes.
reports String[] The reports to generate. This is a list of report aliases or full class names. The aliases are generally the same as the plugin artifactId for the plugin that generates the report, eg: maven-clover-plugin for the Clover report and findbugs-maven-plugin for the FindBugs report. The known aliases are configured in the reports.properties file.

Parameter Details

columns

The columns to generate per report. This is a mapping from report (by report alias or full class name) to comma separated column indexes.

  • Type : java.util.Map
  • Required : No

destinationFile

The name of the file where the dashboard is generated into.

  • Type : java.io.File
  • Required : Yes
  • Expression : ${project.reporting.outputDirectory}/index.html

reports

The reports to generate. This is a list of report aliases or full class names. The aliases are generally the same as the plugin artifactId for the plugin that generates the report, eg: maven-clover-plugin for the Clover report and findbugs-maven-plugin for the FindBugs report. The known aliases are configured in the reports.properties file.

  • Type : java.lang.String[]
  • Required : No

xpathToDestinationNode

The xpath expression of node in the destinationFile where the dashboard table will be generated in. A section will be added to this node, containing a table with the statistics.

  • Type : java.lang.String
  • Required : Yes
  • Expression : //div[@id='contentBox']