org.myire.quill.report

Class ReportBuilder

java.lang.Object

org.myire.quill.report.ReportBuilder

public class ReportBuilder
extends java.lang.Object

A report builder incrementally writes the contents of a report to its destination.

Constructor Summary

Constructors

Constructor and Description
ReportBuilder(java.io.File pDestination) Create a new ReportBuilder.

Method Summary

Modifier and Type	Method and Description
void	close() Close the builder's underlying destination.
void	copy(java.io.File pFile) Copy the contents of a file to this builder's destination.
void	copy(java.lang.String pResource) Copy the contents of a classpath resource to this builder's destination.
java.io.File	getDestination() Get the file this builder is creating.
void	transform(java.io.File pXmlFile, java.io.File pXslFile, java.util.Map<java.lang.String,java.lang.Object> pParameters) Transform an XML file by applying the style sheet from an XSL file and write the result to this builder's destination.
void	transform(java.io.File pXmlFile, java.lang.String pXslResource, java.util.Map<java.lang.String,java.lang.Object> pParameters) Transform an XML file by applying the style sheet from an XSL resource and write the result to this builder's destination.
void	transform(java.lang.String pXml, java.lang.String pXslResource, java.util.Map<java.lang.String,java.lang.Object> pParameters) Transform an XML string by applying the style sheet from an XSL resource and write the result to this builder's destination.
void	write(java.lang.String pString) Write a string to this builder's destination.
void	write(java.lang.String pString, java.nio.charset.Charset pCharset) Write a string to this builder's destination.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportBuilder

public ReportBuilder(java.io.File pDestination)
              throws java.io.FileNotFoundException

Create a new ReportBuilder.

Parameters:

pDestination - The file to write the report to.

Throws:

java.io.FileNotFoundException - if pDestination cannot be created or opened.

java.lang.NullPointerException - if pDestination is null.

Method Detail

getDestination

public java.io.File getDestination()

Get the file this builder is creating.

Returns:

The report file being created.

close

public void close()

Close the builder's underlying destination. Future calls to other methods on this instance will fail.

write

public void write(java.lang.String pString)

Write a string to this builder's destination. The string will be encoded with the platform's default charset.

Parameters:

pString - The string to write.

write

public void write(java.lang.String pString,
                  java.nio.charset.Charset pCharset)

Write a string to this builder's destination.

Parameters:

pString - The string to write.

pCharset - The charset to encode the string with.

copy

public void copy(java.io.File pFile)

Copy the contents of a file to this builder's destination.

Parameters:

pFile - The file to copy.

copy

public void copy(java.lang.String pResource)

Copy the contents of a classpath resource to this builder's destination. The resource will be accessed through the class loader of this builder.

Parameters:

pResource - The name of the resource to copy.

transform

public void transform(java.io.File pXmlFile,
                      java.io.File pXslFile,
                      java.util.Map<java.lang.String,java.lang.Object> pParameters)

Transform an XML file by applying the style sheet from an XSL file and write the result to this builder's destination.

Parameters:

pXmlFile - The XML file to transform.

pXslFile - The XSL file with the style sheet to apply.

pParameters - Any XSL parameters to pass to the transformation.

transform

public void transform(java.io.File pXmlFile,
                      java.lang.String pXslResource,
                      java.util.Map<java.lang.String,java.lang.Object> pParameters)

Transform an XML file by applying the style sheet from an XSL resource and write the result to this builder's destination. The resource will be accessed through the class loader of this builder.

Parameters:

pXmlFile - The XML file to transform.

pXslResource - The XSL resource with the style sheet to apply.

pParameters - Any XSL parameters to pass to the transformation.

transform

public void transform(java.lang.String pXml,
                      java.lang.String pXslResource,
                      java.util.Map<java.lang.String,java.lang.Object> pParameters)

Transform an XML string by applying the style sheet from an XSL resource and write the result to this builder's destination. The resource will be accessed through the class loader of this builder.

Parameters:

pXml - The XML string to transform.

pXslResource - The XSL resource with the style sheet to apply.

pParameters - Any XSL parameters to pass to the transformation.