com.fourjs.report.runtime

Class FourRpProcessor

java.lang.Object

com.fourjs.report.runtime.PXMLProducer

com.fourjs.report.runtime.FourRpProcessor

All Implemented Interfaces:

DataConsumer, java.io.Serializable

public class FourRpProcessor
extends PXMLProducer
implements DataConsumer, java.io.Serializable

Class for conversion of a XML data stream to a PXML document via a ".4rp" template. The template is expected to match the XML data stream. To ensure that, the template is edited against the XML schema (".xsd") of the data stream using the report designer. The schema of the data stream can be conveniently created by the JAXB schema generator schemagen (see Java Architecture for XML Binding (JAXB)) The data stream can be conveniently created using the JAXB marshaller (see JAXB).

Processing large documents

The delay between input and output varies but is seldom more than a few elements of the input stream and the memory consumption is nearly constant. Exceptions are lookahead variables in RTL expressions. Any reference to a variable that is defined in a location where it requires lookahead over one or more repeating elements (maxOccurs>0) delays output until the variable is read in the input. As an example consider a list of invoice items preceded by the string "The total of item is x". Assuming that the value of "x" is shipped after the list of items, the output will be delayed until that point. The report designer displays a warning in the message window in such cases.

Since:

2.50

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FourRpProcessor() Creates a FourRpProcessor object.
	FourRpProcessor(java.lang.String reportFileName, PXMLConsumer consumer) Creates a FourRpProcessor object for the specified template file that outputs to the given handler object.

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.lang.String	getFGLLocalizationCharset()
java.lang.String	getFGLLocalizationNumberFormat()
java.lang.String[]	getFGLLocalizationResourcePath()
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	setEnvironment(org.xml.sax.Attributes values) Specifies variable values in the private environment of the report Can be used to specify the value of environment variables like GREOUTPUTDIR or user defined variables for the purpose of using the values in calls to the RTL function Runtime.getEnvironmentVariable().
void	setFGLLocalizationCharset(java.lang.String fglLocalizationCharset) Specified the charset in which the ".42s" localization files are encoded.
void	setFGLLocalizationNumberFormat(java.lang.String fglLocalizationNumberFormat) Specifies the format pattern to be used for number formatting.
void	setFGLLocalizationResourcePath(java.lang.String[] fglLocalizationResourcePath) Specifies the search path for localization (".42s") files.
void	setRecordingFileName(java.lang.String recordingFileName) Specifies input recording for the purpose of play back or debugging.
void	setRenderingHints(org.xml.sax.Attributes values) Specifies rendering hints to be used during the rendering process Can be used to specify the value of rendering hints.
void	setReportFileName(java.lang.String reportFileName) Specifies the template file that is used for the transformation of the input.

Methods inherited from class com.fourjs.report.runtime.PXMLProducer

setConsumer

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

FourRpProcessor

protected FourRpProcessor()

Creates a FourRpProcessor object. Constructor for the purpose of serialization of classes extending this class.

Since:

2.50

FourRpProcessor

public FourRpProcessor(java.lang.String reportFileName,
                       PXMLConsumer consumer)

Creates a FourRpProcessor object for the specified template file that outputs to the given handler object. If the file name is a relative path then the environment variable (or system property) FGLRESOURCEPATH will be used to search for files (The variable is expected to follow CLASSPATH syntax).

Parameters:

reportFileName - A '.4rp' file

consumer - A FormatHandler

Since:

2.50

See Also:

setReportFileName(java.lang.String)

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:

2.50

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:

2.50

setRecordingFileName

public void setRecordingFileName(java.lang.String recordingFileName)

Specifies input recording for the purpose of play back or debugging. In parallel to the regular processing the input is written in XML format to the file specified by recordingFileName. In the case of a remote connection the file is created on the remote server.

Parameters:

recordingFileName - Name of the XML file in which the input is to be written.

Since:

2.50

setReportFileName

public void setReportFileName(java.lang.String reportFileName)

Specifies the template file that is used for the transformation of the input. If the file name is a relative path then the environment variable (or system property) FGLRESOURCEPATH will be used to search for files (The variable is expected to follow CLASSPATH syntax).

Parameters:

reportFileName - A '.4rp' file

Since:

2.50

setEnvironment

public void setEnvironment(org.xml.sax.Attributes values)

Specifies variable values in the private environment of the report Can be used to specify the value of environment variables like GREOUTPUTDIR or user defined variables for the purpose of using the values in calls to the RTL function Runtime.getEnvironmentVariable().

Parameters:

values - An attribute set defining the environment

Since:

3.00

setRenderingHints

public void setRenderingHints(org.xml.sax.Attributes values)

Specifies rendering hints to be used during the rendering process Can be used to specify the value of rendering hints.

Parameters:

values - An attribute set defining the values

Since:

3.00

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.50

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:

2.50

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:

2.50

getFGLLocalizationCharset

public java.lang.String getFGLLocalizationCharset()

setFGLLocalizationCharset

public void setFGLLocalizationCharset(java.lang.String fglLocalizationCharset)

Specified the charset in which the ".42s" localization files are encoded. By default the system encoding is assumed.

Parameters:

fglLocalizationCharset - An encoding name supported by the JVM (see Charset.availableCharsets())

Since:

2.50

getFGLLocalizationResourcePath

public java.lang.String[] getFGLLocalizationResourcePath()

setFGLLocalizationResourcePath

public void setFGLLocalizationResourcePath(java.lang.String[] fglLocalizationResourcePath)

Specifies the search path for localization (".42s") files.

Parameters:

fglLocalizationResourcePath - Array of directories to search

Since:

2.50

getFGLLocalizationNumberFormat

public java.lang.String getFGLLocalizationNumberFormat()

setFGLLocalizationNumberFormat

public void setFGLLocalizationNumberFormat(java.lang.String fglLocalizationNumberFormat)

Specifies the format pattern to be used for number formatting. The format is compatible with the format of the 4GL DBFORMAT environment variable.

Parameters:

fglLocalizationNumberFormat - A FGL compatible format pattern

Since:

2.50

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