org.myire.quill.report

Class ReportTransformingReport

java.lang.Object

org.myire.quill.common.ProjectAware

org.myire.quill.report.SimpleConfigurableReport

org.myire.quill.report.DefaultDestinationReport

org.myire.quill.report.DefaultSingleFileReport

org.myire.quill.report.ReportTransformingReport

All Implemented Interfaces:

org.gradle.api.reporting.ConfigurableReport, org.gradle.api.reporting.Report, org.gradle.api.reporting.SingleFileReport, org.gradle.util.Configurable<org.gradle.api.reporting.Report>, TransformingReport

Direct Known Subclasses:

FormatChoiceReportTransformingReport

public class ReportTransformingReport
extends DefaultSingleFileReport

A transforming report that applies an XSL transformation on the output/destination of another report to create its own output.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.reporting.Report

org.gradle.api.reporting.Report.OutputType

Field Summary

Fields inherited from interface org.gradle.api.reporting.Report

NAMER

Constructor Summary

Constructors

Constructor and Description
ReportTransformingReport(org.gradle.api.Project pProject, java.lang.String pName, java.lang.String pDisplayName, org.gradle.api.reporting.Report pInput, java.lang.String pXslResource) Create a new ReportTransformingReport.

Method Summary

Modifier and Type	Method and Description
boolean	checkUpToDate() Check if the report is up to date with respect to its XML input.
protected java.io.File	getInputFile() Get the XML input file to transform.
java.io.File	getXslFile() Get the XSL file that will be used to transform the XML input.
boolean	reportIsRequired() Check if this report is required (enabled) and should be created.
void	setXslFile(java.lang.Object pFile) Set the file containing the style sheet to use when transforming the XML input.
void	transform() Transform the report's XML input using the XSL style sheet specified for this report and write the result to this report's destination.

Methods inherited from class org.myire.quill.report.DefaultSingleFileReport

getOutputLocation

Methods inherited from class org.myire.quill.report.DefaultDestinationReport

resolveDestination

Methods inherited from class org.myire.quill.report.SimpleConfigurableReport

configure, getDestination, getDisplayName, getName, getOutputType, getProject, getProjectLogger, getRequired, isEnabled, setDestination, setDestination, setEnabled, setEnabled, setOutputLocation, setRequired, toString, useDestination

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.myire.quill.report.TransformingReport

applyProjectRootXslParameter

Methods inherited from interface org.gradle.api.reporting.SingleFileReport

getOutputLocation, getOutputType

Methods inherited from interface org.gradle.api.reporting.ConfigurableReport

setDestination, setDestination, setEnabled, setEnabled

Methods inherited from interface org.gradle.api.reporting.Report

getDestination, getDisplayName, getName, getRequired, isEnabled

Methods inherited from interface org.gradle.util.Configurable

configure

Constructor Detail

ReportTransformingReport

public ReportTransformingReport(org.gradle.api.Project pProject,
                                java.lang.String pName,
                                java.lang.String pDisplayName,
                                org.gradle.api.reporting.Report pInput,
                                java.lang.String pXslResource)

Create a new ReportTransformingReport.

Parameters:

pProject - The project for which the report will be produced.

pName - The report's symbolic name.

pDisplayName - The report's descriptive name.

pInput - The report to transform the output of.

pXslResource - The resource containing the default style sheet to apply if no XSL file is specified.

Throws:

java.lang.NullPointerException - if pProject or pInput is null.

Method Detail

reportIsRequired

public boolean reportIsRequired()

Description copied from class: SimpleConfigurableReport

Check if this report is required (enabled) and should be created.

Overrides:

reportIsRequired in class SimpleConfigurableReport

Returns:

True if this report is required, false if not.

getInputFile

protected java.io.File getInputFile()

Get the XML input file to transform.

Returns:

The XML input file.

getXslFile

public java.io.File getXslFile()

Description copied from interface: TransformingReport

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

Specified by:

getXslFile in interface TransformingReport

Returns:

The XSL file. If this file is null the implementation may use a default style sheet to perform the transformation.

setXslFile

public void setXslFile(java.lang.Object pFile)

Description copied from interface: TransformingReport

Set the file containing the style sheet to use when transforming the XML input.

Specified by:

setXslFile in interface TransformingReport

Parameters:

pFile - The file specification, will be resolved using Project.file().

checkUpToDate

public boolean checkUpToDate()

Description copied from interface: TransformingReport

Check if the report is up to date with respect to its XML input.

Specified by:

checkUpToDate in interface TransformingReport

Returns:

True if this report is up to date, false if not.

transform

public void transform()

Description copied from interface: TransformingReport

Transform the report's XML input using the XSL style sheet specified for this report and write the result to this report's destination.

Specified by:

transform in interface TransformingReport