com.fourjs.report.runtime

Interface DataConsumer

All Known Implementing Classes:

FourRpLayouter, FourRpProcessor, RemoteConnection, Transformer

public interface DataConsumer

Interface for processors located at the head of the processing pipe.

Since:

2.50

Method Summary

Modifier and Type	Method and Description
org.xml.sax.ContentHandler	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.

Method Detail

createContentHandler

org.xml.sax.ContentHandler 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.

Returns:

A content handler

Throws:

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

Since:

2.50

runFromJAXBObject

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.

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:

2.50

runFromXML

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.

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:

2.50

setDebugLevel

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.

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:

2.50

getDebugLevel

java.lang.Integer getDebugLevel()

Returns the debug level.

Returns:

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

Since:

2.50

See Also:

setDebugLevel(java.lang.Integer)

logInputToFile

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

Specifies to log the input to an XML file.

Parameters:

logFile - The location of the output file

logOnly - Specifies to suppress any further processing of the input

Since:

3.30

getInputLogFile

java.io.File getInputLogFile()

logOnly

boolean logOnly()