org.myire.quill.dashboard

Class DashboardSection

java.lang.Object

org.myire.quill.common.ProjectAware

org.myire.quill.dashboard.DashboardSection

public class DashboardSection
extends ProjectAware

A dashboard section produces an HTML fragment for the reports dashboard. This fragment contains a summary of a report generated during a build. It may also hold a reference to a more detailed report.

The summary is created by applying an XSL transformation to the underlying report's XML version.

Method Summary

Modifier and Type	Method and Description
org.gradle.api.reporting.Report	getDetailedReport() Get the detailed report the section should refer to.
java.lang.String	getName() Get the name of this section.
org.gradle.api.reporting.Report	getReport() Get the underlying XML report for this section.
java.io.File	getXslFile() Get the XSL file that will be used to transform the XML input.
void	setXslFile(java.lang.Object pFile) Set the XSL file to use when transforming the XML input.

Methods inherited from class org.myire.quill.common.ProjectAware

getProject, getProjectLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

@Input
public java.lang.String getName()

Get the name of this section.

Returns:

The section's name.

getReport

public org.gradle.api.reporting.Report getReport()

Get the underlying XML report for this section.

Returns:

The XML report the section's contents are based on.

getDetailedReport

@Optional
public org.gradle.api.reporting.Report getDetailedReport()

Get the detailed report the section should refer to.

Returns:

The section's detailed report, possibly null.

getXslFile

@InputFile
 @Optional
public java.io.File getXslFile()

Get the XSL file that will be used to transform the XML input.

Returns:

The XSL file. If this file is null the default style sheet specified in the constructor will be used to perform the transformation, if available.

setXslFile

public void setXslFile(java.lang.Object pFile)

Set the XSL file to use when transforming the XML input. The specified file will be resolved relative to the project directory.

Parameters:

pFile - The XSL file.