Interface IReportDocument
- All Superinterfaces:
IDocument
A report document (i.e., not modifiable) that can be rendered to other
formats in the BIRT presentation engine
This is the high-level report document interface.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Invoke following code instead:findTOCByName
(String tocName) Deprecated.Invoke following code instead:org.eclipse.birt.core.archive.IDocArchiveReader
getBookmarkInstance
(String bookmark) Return the instance id of report item with the specified bookmarklong
getBookmarkOffset
(String bookmark) Given a report item bookmark, returns the offset of the report content (to support Reportlet).getChildren
(String tocNodeId) Deprecated.Invoke following code instead:return the errors in the document.The report runnable is used to create the report document while writing.getGlobalVariables
(String option) Deprecated.long
Given a report item instance id, returns the offset of the report content (to support Reportlet).long
long
getPageNumber
(String bookmark) Given a bookmark in a report, find the (first) page that the bookmark appears in (for hyperlinks to a bookmark)long
getPageNumber
(InstanceID iid) Given a report item instance idD, returns the page number that the instance starts on (to support Reportlet).returns display texts for all the parameters that are used for generating the current report document.Deprecated.Invoke RenderTask.getParameterValues( ) instead.The report runnable is used to create the report document while writing.getProperty
(String key) Get report document property.org.eclipse.birt.report.model.api.ReportDesignHandle
The report runnable is used to create the report document while writing.return the system id assigned to the documentgetTOCTree
(String format, com.ibm.icu.util.ULocale locale) Deprecated.Invoke following code instead:getTOCTree
(String format, com.ibm.icu.util.ULocale locale, com.ibm.icu.util.TimeZone timeZone) Deprecated.Invoke following code instead:Get report document version.boolean
void
refresh()
check the current readed checkpoint and the current writed check point.
-
Field Details
-
GLOBAL_VARIABLE_OPTION_ALL
static final int GLOBAL_VARIABLE_OPTION_ALL- See Also:
-
GLOBAL_VARIABLE_OPTION_JAVA_ONLY
static final int GLOBAL_VARIABLE_OPTION_JAVA_ONLY- See Also:
-
GLOBAL_VARIABLE_OPTION_JS_ONLY
static final int GLOBAL_VARIABLE_OPTION_JS_ONLY- See Also:
-
-
Method Details
-
getArchive
org.eclipse.birt.core.archive.IDocArchiveReader getArchive() -
getVersion
String getVersion()Get report document version.- Returns:
- version
-
getProperty
Get report document property.- Parameters:
key
-- Returns:
- property
-
getDesignStream
InputStream getDesignStream()- Returns:
- a report design stream. This is useful for rerunning a report based on report document
-
getReportDesign
org.eclipse.birt.report.model.api.ReportDesignHandle getReportDesign()- Returns:
- the report design handle. user always get a new instance from this interface.
-
getReportRunnable
IReportRunnable getReportRunnable()The report runnable is used to create the report document while writing. If the report document is open with, the report runnable is used to render or extract data from the report document. user always get a new instance from this interface.- Returns:
- the runnable report design. It is available because a report document must be run with a report design
-
getPreparedRunnable
IReportRunnable getPreparedRunnable()The report runnable is used to create the report document while writing. If the report document is open with, the report runnable is used to render or extract data from the report document. user always get a new instance from this interface.- Returns:
- the prepared runnable report design. It is available because a report document must be run with a report design
-
getDocumentRunnable
IReportRunnable getDocumentRunnable()The report runnable is used to create the report document while writing. If the report document is open with, the report runnable is used to render or extract data from the report document. The internal instance is returned and user should not modify it.- Returns:
- the prepared runnable report design. It is available because a report document must be run with a report design
-
getParameterValues
Deprecated.Invoke RenderTask.getParameterValues( ) instead.returns values for all the parameters that are used for generating the current report document. Useful for running the report again based on a report document- Returns:
- parameter name/value pairs for generating the current report document.
-
getParameterDisplayTexts
Map getParameterDisplayTexts()returns display texts for all the parameters that are used for generating the current report document. Useful for running the report again based on a report document- Returns:
- parameter name/display text pairs for generating the current report document.
-
getPageCount
long getPageCount()- Returns:
- the page count in the report. Used for supporting page-based viewing
-
getPageNumber
Given a report item instance idD, returns the page number that the instance starts on (to support Reportlet).- Parameters:
iid
- report item instance id- Returns:
- the page number that the instance appears first
-
getInstanceOffset
Given a report item instance id, returns the offset of the report content (to support Reportlet).- Parameters:
iid
- report item instance id- Returns:
- the offset in the content stream
-
getBookmarkOffset
Given a report item bookmark, returns the offset of the report content (to support Reportlet).- Parameters:
bookmark
- bookmark of the report item.- Returns:
- the offset in the content stream
-
getPageNumber
Given a bookmark in a report, find the (first) page that the bookmark appears in (for hyperlinks to a bookmark)- Parameters:
bookmarkName
- bookmark name- Returns:
- the page number that the instance appears first
-
getBookmarks
List getBookmarks()- Returns:
- a list of bookmark strings
-
getChildren
Deprecated.Invoke following code instead:IReportDocument document = ... RenderTask renderTask = engine.createRenderTask( document ); ITOCTree tocTree = renderTask.getTOCTree( ); TOCNode node = tocTree.findTOC(tocNodeId); List result = node.getChildren( );
- Parameters:
tocNodeId
- the id of the parent TOC node. Pass null as the root TOC node- Returns:
- A list of TOC nodes thata re direct child of the parent node
-
findTOC
Deprecated.Invoke following code instead:IReportDocument document = ... RenderTask renderTask = engine.createRenderTask( document ); ITOCTree tocTree = renderTask.getTOCTree( ); TOCNode result = tocTree.findTOC(tocNodeId);
get the TOCNode have the id.- Parameters:
tocNodeId
- the id of the toc.- Returns:
- TOCNode with such an Id. NULL if not founded.
-
findTOCByName
Deprecated.Invoke following code instead:IReportDocument document = ... RenderTask renderTask = engine.createRenderTask( document ); ITOCTree tocTree = renderTask.getTOCTree( ); List result = tocTree.findTOCByValue(tocName);
Gets the TOCNodes with the given name.- Parameters:
tocName
- the name of the toc.- Returns:
- List of all tocs with the specified name.
-
getGlobalVariables
Deprecated.- Returns:
- a map for all the global variables defined in JavaScript or Java
-
isComplete
boolean isComplete()- Returns:
- whether the document has all been written.
-
refresh
void refresh()check the current readed checkpoint and the current writed check point. if equal, do nothing. otherwise, reload the core stream, the checkpoint and page count. -
getTOCTree
Deprecated.Invoke following code instead:IReportDocument document = ... RenderTask renderTask = engine.createRenderTask( document ); ITOCTree tocTree = renderTask.getTOCTree( ); ITOCTree result = new TOCView( tocTree.getRoot( ), document.getReportDesgin( ), locale, TimeZone.getDefault( ), format );
Get the TOC tree- Parameters:
format
- the format to generate the reportlocale
- the locale information to generate the report
-
getTOCTree
@Deprecated ITOCTree getTOCTree(String format, com.ibm.icu.util.ULocale locale, com.ibm.icu.util.TimeZone timeZone) Deprecated.Invoke following code instead:IReportDocument document = ... RenderTask renderTask = engine.createRenderTask( document ); ITOCTree tocTree = renderTask.getTOCTree( ); ITOCTree result = new TOCView( tocTree.getRoot( ), document.getReportDesgin( ), locale, timeZone, format );
Get the TOC tree- Parameters:
format
- the format to generate the reportlocale
- the locale information to generate the reporttimeZone
- the time zone information to generate the report
-
getBookmarkInstance
Return the instance id of report item with the specified bookmark- Parameters:
bookmark
- the bookmark of the report item- Returns:
- the instance id of the report item
-
getSystemId
String getSystemId()return the system id assigned to the document- Returns:
- the system id
-
getDocumentErrors
return the errors in the document. The errors are recorded during document generation phase.- Returns:
- the error list.
-