com.fourjs.report.runtime

Class AbstractStreamingClient

java.lang.Object

com.fourjs.report.runtime.AbstractStreamingClient

All Implemented Interfaces:

LayoutedPagesConsumer, java.io.Serializable

Direct Known Subclasses:

StreamingClientDefaultPrinter, StreamingClientNamedPrinter, StreamingClientPrinterDialog, StreamingClientViewer

public abstract class AbstractStreamingClient
extends java.lang.Object
implements LayoutedPagesConsumer, java.io.Serializable

Class for configuring output to the streaming client.

Streaming client

The streaming client option requires the streaming client component GRV (Genero report viewer) or GDC (Genero desktop client) to be up and running.

Font embedding

Fonts are embedded by default. Embedding is available for any font listed by the utility FontInfo.

Processing large documents

The delay between input and output is one page and the client takes advantage of that displaying the pages immediately. Documents not containing "Page N of M" paginations exhibit nearly constant memory consumption while documents containing them have a linear consumption of about 20 KB per page. The paginations do not interfere with the streaming since a referencing mechanism is used to update the paginations at the end of a block when the total number of pages is known. Please not that printing will be delayed for pages containing such forward references until they are resolved. This delaying has no impact on memory consumption as the streaming client temporarily stores delayed pages on disk.

Since:

2.50

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractStreamingClient.Client
static class	AbstractStreamingClient.Orientation

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AbstractStreamingClient()

Method Summary

Modifier and Type	Method and Description
void	setCharsetToEmbed(java.lang.String charsetToEmbed) Selects a character set for font embedding whose characters will be embedded (if available in the selected fonts).
void	setClient(AbstractStreamingClient.Client client) Sets the client application as determined by the client argument.
void	setClientHost(java.lang.String clientHost) Sets the host name of the remote client application.
void	setClientPort(java.lang.Integer clientPort) Sets the port number at which the client application is listening.
void	setCompressOutput(java.lang.Boolean compressOutput) Indicates whether or not the output will be compressed.
void	setEmbedFonts(java.lang.Boolean embedFonts) Activates font embedding if true, external font referencing if false.
void	setFromPage(java.lang.Integer fromPage) Sets the first page to be included in the document.
void	setOrientationRequested(AbstractStreamingClient.Orientation orientationRequested) Informs the renderer of the orientation of the paper in the printer as determined by the orientationRequested argument.
void	setToPage(java.lang.Integer toPage) Sets the last page (inclusive) to be included in the document.

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

AbstractStreamingClient

public AbstractStreamingClient()

Method Detail

setFromPage

public void setFromPage(java.lang.Integer fromPage)

Sets the first page to be included in the document.

Parameters:

fromPage - an integer greater than zero and less than or equal to toPage.

Throws:

java.lang.IllegalArgumentException - if the above condition is violated.

Since:

2.50

setToPage

public void setToPage(java.lang.Integer toPage)

Sets the last page (inclusive) to be included in the document.

Parameters:

toPage - an integer greater than zero and greater than or equal to fromPage.

Throws:

java.lang.IllegalArgumentException - if the above condition is violated.

Since:

2.50

setEmbedFonts

public void setEmbedFonts(java.lang.Boolean embedFonts)

Activates font embedding if true, external font referencing if false. The default value is true.

Parameters:

embedFonts - whether fonts are embedded in the document or external references are used

Since:

2.50

setCharsetToEmbed

public void setCharsetToEmbed(java.lang.String charsetToEmbed)

Selects a character set for font embedding whose characters will be embedded (if available in the selected fonts). The default value is "DEFAULT".

Parameters:

charsetToEmbed - one of the following values:

• "DEFAULT": All characters from the code pages ISO-8859-1 thru ISO-8859-15 (About 700 characters)
• "ALL": All characters available in a particular font
• Any encoding supported by the JVM (see Charset.availableCharsets())

Since:

2.50

See Also:

setEmbedFonts(java.lang.Boolean)

setCompressOutput

public void setCompressOutput(java.lang.Boolean compressOutput)

Indicates whether or not the output will be compressed. Output compression is disabled by default.

Parameters:

compressOutput - a flag for enabling/disabling compression

Since:

2.50

setClient

public void setClient(AbstractStreamingClient.Client client)

Sets the client application as determined by the client argument.

Parameters:

client - one of the following values:

• GDC (Genero desktop client)
• GRV (Genero report viewer)

Since:

2.50

setClientHost

public void setClientHost(java.lang.String clientHost)

Sets the host name of the remote client application. The default value is parsed from the environment variables FGLSERVER or GRWSERVER in this order. The variables are expected to follow the syntax "host:port" (same syntax as the DISPLAY variable of X Windows). If neither of them are set the default value "localhost" is used.

Parameters:

clientHost - the host name of the remote client application

Since:

2.50

See Also:

setClientPort(java.lang.Integer)

setClientPort

public void setClientPort(java.lang.Integer clientPort)

Sets the port number at which the client application is listening. The value is expected to be a unsigned 16 bit value. The default value is parsed from the environment variables FGLSERVER or GRWSERVER in this order. if The variables are expected to follow the syntax "host:port" (same syntax as the DISPLAY variable of X Windows). If neither of them are set the default value 6400 is used for GDC and 6401 is used for GRV.

Parameters:

clientPort - The port number at which the remote application is listening.

Throws:

java.lang.IllegalArgumentException - if the port isn't an unsigned 16 bit value.

Since:

2.50

See Also:

setClientHost(java.lang.String), setClient(com.fourjs.report.runtime.AbstractStreamingClient.Client)

setOrientationRequested

public void setOrientationRequested(AbstractStreamingClient.Orientation orientationRequested)

Informs the renderer of the orientation of the paper in the printer as determined by the orientationRequested argument. Some printers (typically matrix printers) allow can be loaded with both landscape and portrait paper sheets. For most printers however the printer driver is not aware of the orientation of the paper sheets and so the jobs misprint on one of the two paper types (typically landscape). Calling this function allows to fix this deficiency manually.

Parameters:

orientationRequested - one of the following values:

• landscape: If the page defined in the report is higher than wide then rotate pages by 90 degrees before printing.
• portrait: If the page defined in the report is wider than high then rotate pages by 90 degrees before printing.

Since:

2.50