EngineRenderData (i-net Clear Reports API Documentation)

Overview

Package

Class

Use

Deprecated

Help

i-net Clear Reports

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.inet.report
Class EngineRenderData

java.lang.Object
  com.inet.report.EngineRenderData

All Implemented Interfaces:: RenderData

public class EngineRenderData
extends java.lang.Object
implements RenderData
extends java.lang.Object
implements RenderData

This implementation of RenderData uses a created Engine to provide all render data to the i-net Clear Reports viewer. When the report viewer requires data, either a new Engine is created if necessary, or an already existing one is used, and then the data requirement is simply passed on to the Engine.
One notable unique characteristic of EngineRenderData is that it allows you to set your own PropertiesChecker which is used before rendering to check and handle whichever properties you'd like to create custom behavior for. See the documentation of the PropertiesChecker interface for more information.

Notes for overriding

All methods in this class must be thread safe except the methods getExportChunkCount and getNextExportChunk.
Each ReportView can have its own instance of RenderData, so the RenderData methods may be called simultaneously for different ReportViews and different RenderData instances.

See Also:: PropertiesChecker, setPropertiesChecker(PropertiesChecker)

Field Summary

Fields inherited from interface com.inet.viewer.RenderData
`CASE_SENSITIVE, REGULAR_EXPRESSION, WHOLE_WORD`

Constructor Summary
`EngineRenderData(java.lang.String props)` Creates an instance of `EngineRenderData`, decoding any properties in the `String`.

Method Summary
`protected Engine`	`checkEngine(java.util.Properties props)` Constructs a new `Engine` according to the given properties and cache it.
`void`	`clearEngineCache()` Clears the local engine cache of this `EngineRenderData`, so that new engines will be created at the next request for report data.
`protected Engine`	`createEngine(java.util.Properties props)` Creates or load an `Engine` and set all needed properties.
`RenderData`	`getCopy()` "Clones" this RenderData object with all its properties and returns the copy.
`protected Engine`	`getEngine(java.lang.String key)` Get the `Engine` from the cache if exists.
`int`	`getExportChunkCount(java.util.Properties expProps)` Returns the total number of export "chunks" for the report for the specified export format.
`byte[]`	`getFontData(int fontID)` Returns the byte array of the embedded font at the specified fontId, which is encoded in the Viewer's protocol.
`byte[]`	`getGroupTree()` Returns the group tree which can be sent to the java viewer as a byte array.
`protected java.lang.String`	`getKey(java.util.Properties props)` Create a key for the given properties.
`byte[]`	`getNextExportChunk()` Returns the current export chunk.
`int`	`getPageCount()` Returns the number of pages in the report.
`byte[]`	`getPageData(int page)` Returns the binary data of one page for the Java Viewer.
`java.util.Properties`	`getProperties()` Returns the Properties object used by this RenderData object.
`PropertiesChecker`	`getPropertiesChecker()` Returns the `PropertiesChecker` currently set for this render data.
`java.lang.String`	`getReportLocation()` Returns the location of the report set by setReportLocation.
`java.lang.String`	`getReportProperty(java.lang.String key)` Returns the chosen property value which has been set either via setReportProperty or otherwise.
`java.lang.String`	`getReportTitle()` Returns the manually set title of the report if there is one, that is, what would be typically displayed in a title bar, e.g.
`boolean`	`isPageLimitExceeded()` Check if the rendering of the report ran into a page limit.
`boolean`	`isPromptOnRefresh()` Returns the property "promptOnRefresh", that is, whether prompts are to be shown whenever new data is fetched from the server.
`byte[]`	`refreshPageData(int page)` Returns the binary data of one page for the Java Viewer, however, it causes the page to be rendered anew rather than possibly taking a cached version.
`void`	`resetServerCacheTimeout()` Since this `RenderData` works with fully rendered Engines, there is no timeout to reset, therefore the implementation of this method does not need to do anything.
`byte[]`	`search(java.lang.String phrase, int startPage, int flags)` Searches the given phrase in the report, starting at a certain page and using the search options given in the flags.
`protected Engine`	`setEngineParams(Engine engine, java.util.Properties props)` Overrides the properties stored in the `Engine` with the properties stored in props.
`protected Engine`	`setEngineParams(Engine engine, java.util.Properties props, boolean rdc)` Overrides the properties stored in the `Engine` with the properties stored in props.
`void`	`setPromptOnRefresh(boolean promptOnRefresh)` Sets the property "promptOnRefresh", that is, whether prompts are to be shown whenever the report is refreshed, that is, whenever new data is fetched from the server.
`void`	`setPropertiesChecker(PropertiesChecker propChecker)` Enables you to set your own `PropertiesChecker` which will be used before the rendering process to handle certain properties.
`void`	`setReportLocation(java.lang.String location)` Sets the location of the report which this RenderData is to obtain its data for.
`void`	`setReportProperty(java.lang.String key, java.lang.String value)` Sets the given property for the report.
`void`	`setReportTitle(java.lang.String title)` Sets the title of the report.
`void`	`stop()` Stops and cancels the rendering process if one is running.

Constructor Detail

EngineRenderData

public EngineRenderData(java.lang.String props)

Creates an instance of EngineRenderData, decoding any properties in the String. An example props string would be: "report=Test.rpt&promptTest=12&promptBlue=Red&promptonrefresh=true"

Parameters:: props - A String specifying any properties wanted for the connection, in the form "prop1=value1&prop2=value2&..."

Method Detail

setReportLocation

public void setReportLocation(java.lang.String location)

Sets the location of the report which this RenderData is to obtain its data for. Any properties can be attached to the end using "=" for separating property name and value, and "&" for separating the various properties, e.g. "...&init=pdf&promptABC=test..." The location may not be null.

Specified by:: setReportLocation in interface RenderData

Parameters:: location - The location at which the report can be found. May not be null. *

getReportLocation

public java.lang.String getReportLocation()

Returns the location of the report set by setReportLocation. This will never be null. An uninitialized location will be returned as an empty string.

Specified by:: getReportLocation in interface RenderData

Returns:: Report Location (e.g URL)
See Also:: *

clearEngineCache

public void clearEngineCache()

Clears the local engine cache of this EngineRenderData, so that new engines will be created at the next request for report data.

createEngine

protected Engine createEngine(java.util.Properties props)
                       throws ReportException

Creates or load an Engine and set all needed properties. Do NOT execute the Engine here!

Parameters:: props - Properties to use for creating the engine.
Returns:: the created engine
Throws:: ReportException - if the specified export format is invalid.

getKey

protected java.lang.String getKey(java.util.Properties props)
                           throws ReportException

Create a key for the given properties. The key will be used in a HashTable.

Parameters:: props - Properties to use for creating the engine.
Returns:: a key, never null
Throws:: ReportException - If an error occurred during checking the supplied properties with the current PropertiesChecker.
Since:: 10.0

getEngine

protected Engine getEngine(java.lang.String key)

Get the Engine from the cache if exists.

Parameters:: key - the key of the Engine
Returns:: the Engine or null
Since:: 10.0
See Also:: getKey(java.util.Properties)

checkEngine

protected Engine checkEngine(java.util.Properties props)
                      throws ReportException

Constructs a new Engine according to the given properties and cache it.
This method does the following:

Check if an Engine with this properties (see props above) already exists.
If so, discards it if the call occur from refreshPageData(int).
If the Engine does not exist, it calls createEngine(exportFormat).
It calls engine.execute().
Returns the executed Engine

Parameters:

props - Properties to use for creating the engine.

Returns:

the executed engine

Throws:

ReportException - If:

an error occurred during checking the supplied properties with the current PropertiesChecker,
if the specified export format is invalid,
used Engine is not initialized or finished.

setEngineParams

protected Engine setEngineParams(Engine engine,
                                 java.util.Properties props)

Overrides the properties stored in the Engine with the properties stored in props.

Parameters:: engine - The uninitialized report Engine; props - The stored properties from the request (report=...&prompt<...>=...)
Returns:: The initialized Engine
Throws:: java.lang.RuntimeException - If it could not set the engine properties.

setEngineParams

protected Engine setEngineParams(Engine engine,
                                 java.util.Properties props,
                                 boolean rdc)

Overrides the properties stored in the Engine with the properties stored in props.

Parameters:: engine - The uninitialized report Engine; props - The stored properties from the request (report=...&prompt<...>=...); rdc - true if the report should not load because the engine was created with the RDC API.
Returns:: The initialized engine
Throws:: java.lang.RuntimeException - If it could not set the engine properties.

setPropertiesChecker

public void setPropertiesChecker(PropertiesChecker propChecker)

Enables you to set your own PropertiesChecker which will be used before the rendering process to handle certain properties. For example, you could implement the following method in the PropertiesChecker you pass here in order to check and handle certain custom properties as you wish:

 public void checkProperties(Properties reportProperties, Object servletRequest) {
     String currentReportName;
     currentReportName = ((String)reportProperties.get("report")).toLowerCase();
     // check report name
     if (currentReportName.indexOf("report1.rpt") != -1) {
         // change report parameter values
         // for report1 we change password and the RecordSelectionFormula
         reportProperties.put("password", "Password");
         reportProperties.put("sf", "{List.UserID} = 404");
     } else if (currentReportName.indexOf("report2.rpt") != -1) {
         // change report parameter values
         // for report2 we set a date in a parameter field
         reportProperties.put("prompt0", "Date(2000,05,18)");
     } else if (currentReportName.indexOf("report3.rpt") != -1) {
         // change report parameter values
         // for report3 we change the database
         // Example: report3 was designed with the ODBC driver
         // Now we will use this report with the MS SQL Server
         // To do this we set another Data Source Configuration 
         reportProperties.put("datasource", "SqlServerDataSource");
     }
 }

Parameters:: propChecker - PropertiesChecker to set for this EngineRenderData, may not be null.
Throws:: java.lang.IllegalArgumentException - If propChecker is null
See Also:: PropertiesChecker

getPropertiesChecker

public PropertiesChecker getPropertiesChecker()

Returns the PropertiesChecker currently set for this render data. See setPropertiesChecker(PropertiesChecker) for more information about properties checkers.

Returns:: PropertiesChecker for this RenderData, will never be null.

getPageData

public byte[] getPageData(int page)
                   throws ViewerException

Returns the binary data of one page for the Java Viewer. Note that this method is thread-safe, that is, two or more threads concurrently calling this method and the other thread-safe methods in RenderData should cause no problems.

Specified by:: getPageData in interface RenderData

Parameters:: page - The number of the page. The first page is 1, the second is 2, ... .
If the page number is not valid (usually meaning the page number is outside the page range), null can be returned.
Returns:: The binary data of the page for the Java viewer, or possibly null if page number is not valid.
Throws:: ViewerException - If an exception is returned from the server, it is wrapped in a ViewerException. Often this will be a com.inet.report.ReportException
See Also:: RenderData.getPageCount()

getPageCount

public int getPageCount()
                 throws ViewerException

Returns the number of pages in the report.
This method is waiting until the rendering process is finished. This is useful if you use i-net Clear Reports with external result sets or connections and you want to know when the rendering process is finished and you can close these external result sets or connections.

Specified by:: getPageCount in interface RenderData

Returns:: number of pages
Throws:: ViewerException - If a problem occurs while rendering the report, the exception is wrapped in a ViewerException
See Also:: getPageData(int)

isPageLimitExceeded

public boolean isPageLimitExceeded()
                            throws ViewerException

Check if the rendering of the report ran into a page limit. This means does not all possible pages exist.

Specified by:: isPageLimitExceeded in interface RenderData

Returns:: true, if there is a limit
Throws:: ViewerException - If there are rendering problems, etc.

getNextExportChunk

public byte[] getNextExportChunk()
                          throws ViewerException

Returns the current export chunk.
This method returns the current export chunk, with the exception that SVG pages will be changed and a viewer attached.

Specified by:: getNextExportChunk in interface RenderData

Returns:: chunk
Throws:: ViewerException - If an error occurs while rendering the report, the exception is wrapped in a ViewerException
See Also:: RenderData.getExportChunkCount(Properties)

getExportChunkCount

public int getExportChunkCount(java.util.Properties expProps)
                        throws ViewerException

Returns the total number of export "chunks" for the report for the specified export format.
A "chunk" is a unit of export data which can be retrieved using getNextExportChunk(). This method blocks until the rendering process is finished on the server. Note that this method is thread-safe, that is, two or more threads concurrently calling this method and the other thread-safe methods in RenderData should cause no problems.
In case of gzip compression, the number of chunks can not be determined and "0" is returned. The chunks can be retrieved in a loop until getNextExportChunk() returns NULL.

Specified by:: getExportChunkCount in interface RenderData

Parameters:: expProps - Properties to be appended to the current report properties for this export. The properties should contain at least the export format with the key "export_fmt". The following formats are valid:
"pdf" - pdf file
"rtf" - rtf file
"xls" - xls file
"csv" - csv file
"ps" - ps file
"xml" -xml file
"htm" - html files, The file name is the base filename, because there are more files with links.
For a complete list of report URL properties see the documentation.
Returns:: Total number of export "chunks" (i.e. units) which can be fetched using getNextExportChunk()
Throws:: ViewerException - If there are connection problems or other issues while fetching the data
See Also:: RenderData.getNextExportChunk(), RenderData.getProperties()

getGroupTree

public byte[] getGroupTree()
                    throws ViewerException

Returns the group tree which can be sent to the java viewer as a byte array. Note that this method is thread-safe, that is, two or more threads concurrently calling this method and the other thread-safe methods in RenderData should cause no problems.

Specified by:: getGroupTree in interface RenderData

Returns:: byte[] Group Tree as byte array, encoded by i-net Clear Reports.
Throws:: ViewerException - If there are connection problems or other issues while fetching the data

refreshPageData

public byte[] refreshPageData(int page)
                       throws ViewerException

Returns the binary data of one page for the Java Viewer, however, it causes the page to be rendered anew rather than possibly taking a cached version.

Specified by:: refreshPageData in interface RenderData

Parameters:: page - The number of the page. The first page is 1, the second is 2, ... . If the page number is bigger than the page count the data from the last page will be returned.
Returns:: the binary data for the Java Viewer
Throws:: ViewerException - If there are connection problems or other issues while fetching the data
See Also:: RenderData.getPageCount()

setReportProperty

public void setReportProperty(java.lang.String key,
                              java.lang.String value)

Sets the given property for the report. See http://www.inetsoftware.de/documentation/clear-reports/online-help/features/report-url-parameters.html for a list of possible properties to set here and what they mean.
Setting null as the value will cause the removal of the property. If a prompt property is to be explicitly set to the value "null", simply set the string "formula:null" as the value.

Specified by:: setReportProperty in interface RenderData

Parameters:: key - Name of property to set, will be converted to lower case; value - Value of property to set, null to remove this property

getReportProperty

public final java.lang.String getReportProperty(java.lang.String key)

Returns the chosen property value which has been set either via setReportProperty or otherwise.

Specified by:: getReportProperty in interface RenderData

Parameters:: key - Name of property to get value for
Returns:: Value of property with the given name

setPromptOnRefresh

public void setPromptOnRefresh(boolean promptOnRefresh)

Sets the property "promptOnRefresh", that is, whether prompts are to be shown whenever the report is refreshed, that is, whenever new data is fetched from the server.

Specified by:: setPromptOnRefresh in interface RenderData

Parameters:: promptOnRefresh - Value to set for this property

isPromptOnRefresh

public boolean isPromptOnRefresh()

Returns the property "promptOnRefresh", that is, whether prompts are to be shown whenever new data is fetched from the server.

Specified by:: isPromptOnRefresh in interface RenderData

Returns:: The property "promptOnRefresh"

setReportTitle

public void setReportTitle(java.lang.String title)

Sets the title of the report. This title is what would be typically displayed in a title bar, e.g. "Employee Report 2005". Note that if this is not manually set, the title will be whatever the report has set as its title. If a title is set, it overrides the "actual" report title.

Specified by:: setReportTitle in interface RenderData

Parameters:: title - Title of the report as simple string.

getReportTitle

public java.lang.String getReportTitle()

Returns the manually set title of the report if there is one, that is, what would be typically displayed in a title bar, e.g. "Employee Report 2005". This will return null if no title was manually set.

Specified by:: getReportTitle in interface RenderData

Returns:: Title of report

getCopy

public RenderData getCopy()

"Clones" this RenderData object with all its properties and returns the copy. Useful for deriving from existing RenderData objects by copying them and adding or changing properties. This method is called by the viewer for drilling down, for example - the drilldown property is set on the copy while all other properties remain the same, and the copy is used to open a new report view.

Specified by:: getCopy in interface RenderData

Returns:: A cloned copy of this RenderData object with all its properties.
See Also:: ReportViewer.addNewReportView(RenderData), RenderData.getProperties()

getProperties

public java.util.Properties getProperties()

Returns the Properties object used by this RenderData object. Note this is NOT a clone but rather the exact object used by RenderData - any changes made to this Properties object will influence the RenderData. See http://www.inetsoftware.de/documentation/clear-reports/online-help/features/report-url-parameters.html for a list of possible properties to set here and what they mean.

Note also that any key values should be set in lower case. This Properties object will never be null, at most it will be empty.

Specified by:: getProperties in interface RenderData

Returns:: Properties object used by RenderData, never null

stop

public void stop()

Stops and cancels the rendering process if one is running. This command ends up being passed through to i-net Clear Reports rendering engine and running Engine.stop.

Specified by:: stop in interface RenderData

search

public byte[] search(java.lang.String phrase,
                     int startPage,
                     int flags)

Searches the given phrase in the report, starting at a certain page and using the search options given in the flags. These flags are:

WHOLE_WORD : search only the word in its entirety, not parts of words.
CASE_SENSITIVE : observe upper and lower cases in the search, that is "Search" != "search"
REGULAR_EXPRESSION : The search phrase is to be handled as a regular expression (using Java's Regex methods for the search).

Desired flags should be connected by the OR operator "|". So, for example, to search with the flags WHOLE_WORD and CASE_SENSITIVE, simply use WHOLE_WORD | CASE_SENSITIVE as the flags option.

Note that phrases going over more than one page will not be found, nor will text parts with formatting inside the word itself, such as this word. Note that this method is thread-safe, that is, two or more threads concurrently calling this method and the other thread-safe methods in RenderData should cause no problems.

Specified by:: search in interface RenderData

Parameters:: phrase - Word or phrase to search. Should be a regular expression if this flag is set.; startPage - Page to start searching on (1-based); flags - Desired search options (see above)
Returns:: Search result by the server, encoded in the i-net Clear Reports protocol.
See Also:: RenderData.WHOLE_WORD, RenderData.CASE_SENSITIVE, RenderData.REGULAR_EXPRESSION

getFontData

public byte[] getFontData(int fontID)

Returns the byte array of the embedded font at the specified fontId, which is encoded in the Viewer's protocol. You need not and should not call this method yourself - rather the Viewer will call this method on its own when an embedded font needs to be fetched for the report.

The fontID is 1-based. null will be returned if there are no fonts embedded for the report of this Engine. If fontID is greater than the number of embedded fonts available it will return the last font available. This method is the mirror method to com.inet.report.Engine.getFontData(int), so implementations can either call that if an engine is available, or a running i-net Clear Reports server also returns the font data with an HTTP request of the form "http://server:9000/?report=report.rpt&export_fmt=font&page=FONTID&cmd=get_pg" where FONTID is replaced with the given font ID. Note that this method is thread-safe, that is, two or more threads concurrently calling this method and the other thread-safe methods in RenderData should cause no problems.

Specified by:: getFontData in interface RenderData

Parameters:: fontID - ID of font as specified in the i-net Clear Reports protocol
Returns:: Partial or whole font with the ID, and with the most current version of this font known to the server.

resetServerCacheTimeout

public void resetServerCacheTimeout()

Since this RenderData works with fully rendered Engines, there is no timeout to reset, therefore the implementation of this method does not need to do anything.

Specified by:: resetServerCacheTimeout in interface RenderData

Throws:: ViewerException - always so the viewer only tries once
See Also:: RenderData.resetServerCacheTimeout()

Overview

Package

Class

Use

Deprecated

Help

i-net Clear Reports

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.inet.report Class EngineRenderData

Notes for overriding

EngineRenderData

setReportLocation

getReportLocation

clearEngineCache

createEngine

getKey

getEngine

checkEngine

setEngineParams

setEngineParams

setPropertiesChecker

getPropertiesChecker

getPageData

getPageCount

isPageLimitExceeded

getNextExportChunk

getExportChunkCount

getGroupTree

refreshPageData

setReportProperty

getReportProperty

setPromptOnRefresh

isPromptOnRefresh

setReportTitle

getReportTitle

getCopy

getProperties

stop

search

getFontData

resetServerCacheTimeout

com.inet.report
Class EngineRenderData