com.fourjs.report.runtime

Class Transformer

java.lang.Object

com.fourjs.report.runtime.Transformer

All Implemented Interfaces:

DataConsumer, java.io.Serializable

public class Transformer
extends java.lang.Object
implements DataConsumer, java.io.Serializable

Class for transforming and serializing data

Specifying the transformation

The transformation is configured by specifying a URL to a rst file in a call to the function setRstFileURL.

Serializing the result to an XML file

The transformation result is serialized to and XML file specified in a call to the function setOutputFile.

Since:

3.20

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	legalCopyright

Constructor Summary

Constructors

Constructor and Description
Transformer() Creates a Transformer object.
Transformer(java.net.URL rstFileURL, java.io.File outputFile) Creates a Transformer object for the specified transformation file and outputs to the given file.

Method Summary

Modifier and Type	Method and Description
GreContentHandler	createContentHandler() Creates a content handler into which the input document can be streamed thru the rendering pipe.
java.lang.Integer	getDebugLevel() Returns the debug level.
java.io.File	getInputLogFile()
void	logInputToFile(java.io.File logFile, boolean logOnly) Specifies to log the input to an XML file.
boolean	logOnly()
void	runFromJAXBObject(java.lang.Object data) Uses JAXB to stream the object data thru the rendering pipe.
void	runFromXML(java.lang.String fileName) Streams the specified file thru the rendering pipe.
void	setDebugLevel(java.lang.Integer level) Sets the debug level as determined by the level.
void	setOutputFile(java.io.File outputFile) Specifies the output file location
void	setRstFileURL(java.net.URL rstFileURL) Specifies the URL location of the rst file

Methods inherited from class java.lang.Object

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

Field Detail

legalCopyright

public static final java.lang.String legalCopyright

See Also:

Constant Field Values

Constructor Detail

Transformer

public Transformer()

Creates a Transformer object.

Since:

3.20

Transformer

public Transformer(java.net.URL rstFileURL,
                   java.io.File outputFile)

Creates a Transformer object for the specified transformation file and outputs to the given file.

Parameters:

rstFileURL - The location of the rst file

outputFile - The location of the output file

Since:

3.20

See Also:

setRstFileURL(java.net.URL), setOutputFile(java.io.File)

Method Detail

getDebugLevel

public java.lang.Integer getDebugLevel()

Returns the debug level.

Specified by:

getDebugLevel in interface DataConsumer

Returns:

an Integer value that represents the verbosity level of debug output or null in case that no debug level has been set.

Since:

3.20

See Also:

setDebugLevel(java.lang.Integer)

setDebugLevel

public void setDebugLevel(java.lang.Integer level)

Sets the debug level as determined by the level. Only Messages with a message level lower or equal to level will be displayed and logged. There following six message levels are defined:

• 1: Fatal
• 2: Error
• 3: Warning
• 4: Info
• 5: Debug
• 6: Trace

A level of 0 suppresses all messages. The default value is the value of the system property or the environment variable GREDBUG or 3 if neither is set. The value applies to the local GRE only and not to a remote server.

Specified by:

setDebugLevel in interface DataConsumer

Parameters:

level - Messages with a level higher than this value will not be displayed or logged.

Throws:

java.lang.IllegalArgumentException - if the level is not in the range 0..9

Since:

3.20

setRstFileURL

public void setRstFileURL(java.net.URL rstFileURL)

Specifies the URL location of the rst file

Parameters:

rstFileURL - The location of the rst file

Since:

3.20

setOutputFile

public void setOutputFile(java.io.File outputFile)

Specifies the output file location

Parameters:

outputFile - The location of the output file

Since:

3.20

createContentHandler

public GreContentHandler createContentHandler()
                                       throws org.xml.sax.SAXException

Creates a content handler into which the input document can be streamed thru the rendering pipe. The handler can be used for one stream only.

Specified by:

createContentHandler in interface DataConsumer

Returns:

A content handler

Throws:

org.xml.sax.SAXException - if the handler can't be obtained due to an error

Since:

2.30

runFromJAXBObject

public void runFromJAXBObject(java.lang.Object data)
                       throws javax.xml.bind.JAXBException,
                              org.xml.sax.SAXException

Uses JAXB to stream the object data thru the rendering pipe.

Specified by:

runFromJAXBObject in interface DataConsumer

Parameters:

data - A Java object annotated for JAXP processing

Throws:

javax.xml.bind.JAXBException - if the serialization of the object fails

org.xml.sax.SAXException - if processing the object's data fails

Since:

3.20

runFromXML

public void runFromXML(java.lang.String fileName)
                throws org.xml.sax.SAXException,
                       java.io.IOException,
                       javax.xml.parsers.ParserConfigurationException

Streams the specified file thru the rendering pipe.

Specified by:

runFromXML in interface DataConsumer

Parameters:

fileName - The XML input document

Throws:

java.io.IOException - if reading the data fails

org.xml.sax.SAXException - if processing data fails

javax.xml.parsers.ParserConfigurationException - if parsing the data fails

Since:

3.20

logInputToFile

public void logInputToFile(java.io.File logFile,
                           boolean logOnly)

Specifies to log the input to an XML file.

Specified by:

logInputToFile in interface DataConsumer

Parameters:

logFile - The location of the output file

logOnly - Specifies to suppress any further processing of the input

Since:

3.30

getInputLogFile

public java.io.File getInputLogFile()

Specified by:

getInputLogFile in interface DataConsumer

logOnly

public boolean logOnly()

Specified by:

logOnly in interface DataConsumer