com.fourjs.report.runtime

Class FourRpLayouter

java.lang.Object

com.fourjs.report.runtime.LayoutedPagesProducer

com.fourjs.report.runtime.FourRpLayouter

All Implemented Interfaces:

DataConsumer, java.io.Serializable

public class FourRpLayouter
extends LayoutedPagesProducer
implements DataConsumer, java.io.Serializable

Class for conversion of a XML data stream to a layouted PXML document via a ".4rp" template. This class exists for convenience and is a composition of the classes FourRpProcessor and PXMLLayouter containing the methods of both classes. For details refer to the respective documentation.

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	FourRpLayouter() Creates a FourRpLayouter object.
	FourRpLayouter(java.lang.String filename, LayoutedPagesConsumer consumer) Creates a FourRpLayouter object for the specified template file that outputs to the given consumer 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.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	setAuthor(java.lang.String author) Sets the report's author metadata attribute.
void	setBottomMargin(java.lang.String bottomMarginExpression) Specifies the bottom margin as a PXML numeric expression (e.g.
void	setConsumer(LayoutedPagesConsumer consumer) Sets the output consumer.
void	setCreator(java.lang.String creator) Sets the report creator.
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	setKeywords(java.lang.String keywords) Sets the report's keywords meta data attribute.
void	setLeftMargin(java.lang.String leftMarginExpression) Specifies the left margin as a PXML numeric expression (e.g.
void	setMarkOverfullBoxesInDocument(java.lang.Boolean markOverfullBoxesInDocument) Activates visual marking of overfull boxes if true.
void	setPageLength(java.lang.String pageLengthExpression) Specifies the page height as a PXML numeric expression (e.g.
void	setPageWidth(java.lang.String pageWidthExpression) Specifies the page width as a PXML numeric expression (e.g.
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.
void	setRightMargin(java.lang.String rightMarginExpression) Specifies the right margin as a PXML numeric expression (e.g.
void	setSubject(java.lang.String subject) Sets the report subject.
void	setTitle(java.lang.String title) Sets the report title.
void	setTopMargin(java.lang.String topMarginExpression) Specifies the top margin as a PXML numeric expression (e.g.

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

FourRpLayouter

protected FourRpLayouter()

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

Since:

2.50

FourRpLayouter

public FourRpLayouter(java.lang.String filename,
                      LayoutedPagesConsumer consumer)

Creates a FourRpLayouter object for the specified template file that outputs to the given consumer 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:

filename - A '.4rp' file

consumer - A LayoutedPageConsumer

Since:

2.50

See Also:

setReportFileName(java.lang.String)

Method Detail

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

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:

2.50

setPageWidth

public void setPageWidth(java.lang.String pageWidthExpression)

Specifies the page width as a PXML numeric expression (e.g. "21cm" or "a4width").

Parameters:

pageWidthExpression - A PXML numeric expression.

Throws:

java.lang.IllegalArgumentException - if the expression isn't a valid PXML numeric expression

Since:

2.50

setPageLength

public void setPageLength(java.lang.String pageLengthExpression)

Specifies the page height as a PXML numeric expression (e.g. "8.5in" or "letterlength").

Parameters:

pageLengthExpression - A PXML numeric expression.

Throws:

java.lang.IllegalArgumentException - if the expression isn't a valid PXML numeric expression

Since:

2.50

setLeftMargin

public void setLeftMargin(java.lang.String leftMarginExpression)

Specifies the left margin as a PXML numeric expression (e.g. "1.5cm")

Parameters:

leftMarginExpression - A PXML numeric expression.

Throws:

java.lang.IllegalArgumentException - if the expression isn't a valid PXML numeric expression

Since:

2.50

setTopMargin

public void setTopMargin(java.lang.String topMarginExpression)

Specifies the top margin as a PXML numeric expression (e.g. "1.5cm")

Parameters:

topMarginExpression - A PXML numeric expression.

Throws:

java.lang.IllegalArgumentException - if the expression isn't a valid PXML numeric expression

Since:

2.50

setRightMargin

public void setRightMargin(java.lang.String rightMarginExpression)

Specifies the right margin as a PXML numeric expression (e.g. "1.5cm")

Parameters:

rightMarginExpression - A PXML numeric expression.

Throws:

java.lang.IllegalArgumentException - if the expression isn't a valid PXML numeric expression

Since:

2.50

setBottomMargin

public void setBottomMargin(java.lang.String bottomMarginExpression)

Specifies the bottom margin as a PXML numeric expression (e.g. "1.5cm")

Parameters:

bottomMarginExpression - A PXML numeric expression.

Throws:

java.lang.IllegalArgumentException - if the expression isn't a valid PXML numeric expression

Since:

2.50

setTitle

public void setTitle(java.lang.String title)

Sets the report title. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report title property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the FourRpProcessor.

Parameters:

title - The report title.

Since:

2.50

setAuthor

public void setAuthor(java.lang.String author)

Sets the report's author metadata attribute. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report author property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the FourRpProcessor.

Parameters:

author - The report's author metadata attribute.

Since:

2.50

setCreator

public void setCreator(java.lang.String creator)

Sets the report creator. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report creator property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the FourRpProcessor.

Parameters:

creator - The report creator.

Since:

2.50

setSubject

public void setSubject(java.lang.String subject)

Sets the report subject. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report subject property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the FourRpProcessor.

Parameters:

subject - The report subject.

Since:

2.50

setKeywords

public void setKeywords(java.lang.String keywords)

Sets the report's keywords meta data attribute. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report keyword property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the FourRpProcessor.

Parameters:

keywords - The report's keywords.

Since:

2.50

setMarkOverfullBoxesInDocument

public void setMarkOverfullBoxesInDocument(java.lang.Boolean markOverfullBoxesInDocument)

Activates visual marking of overfull boxes if true. If activated, overfull boxes will be highlighted in red for the purpose of debugging. The default value is false.

Parameters:

markOverfullBoxesInDocument - whether overfull boxes are visually marked.

Since:

2.50

setConsumer

public void setConsumer(LayoutedPagesConsumer consumer)

Sets the output consumer.

Overrides:

setConsumer in class LayoutedPagesProducer

Parameters:

consumer - The output consumer.

Since:

2.50

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

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

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

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

See Also:

FourRpLayouter(java.lang.String, com.fourjs.report.runtime.LayoutedPagesConsumer)

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

See Also:

FourRpLayouter(java.lang.String, com.fourjs.report.runtime.LayoutedPagesConsumer)

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

See Also:

FourRpLayouter(java.lang.String, com.fourjs.report.runtime.LayoutedPagesConsumer)

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

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