org.eclipse.birt.report.engine.api
Interface IReportDocument


public interface IReportDocument

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. Low-level report document interface that supports file-level operations is in a separate interface.


Field Summary
static int GLOBAL_VARIABLE_OPTION_ALL
           
static int GLOBAL_VARIABLE_OPTION_JAVA_ONLY
           
static int GLOBAL_VARIABLE_OPTION_JS_ONLY
           
 
Method Summary
 void close()
          close the report document, rlease all resources.
 TOCNode findTOC(java.lang.String tocNodeId)
          get the TOCNode have the id.
 org.eclipse.birt.core.archive.IDocArchiveReader getArchive()
           
 java.util.List getBookmarks()
           
 java.util.List getChildren(java.lang.String tocNodeId)
           
 java.io.InputStream getDesignStream()
           
 java.util.Map getGlobalVariables(java.lang.String option)
           
 java.lang.String getName()
           
 long getPageCount()
           
 long getPageNumber(java.lang.String bookmark)
          Given a bookmark in a report, find the (first) page that the bookmark appears in (for hyperlinks to a bookmark)
 java.util.Map getParameterValues()
          returns values for all the parameters that are used for generating the current report document.
 IReportRunnable getReportRunnable()
          The report runnable is used to create the report document while writing.
 

Field Detail

GLOBAL_VARIABLE_OPTION_ALL

public static final int GLOBAL_VARIABLE_OPTION_ALL
See Also:
Constant Field Values

GLOBAL_VARIABLE_OPTION_JAVA_ONLY

public static final int GLOBAL_VARIABLE_OPTION_JAVA_ONLY
See Also:
Constant Field Values

GLOBAL_VARIABLE_OPTION_JS_ONLY

public static final int GLOBAL_VARIABLE_OPTION_JS_ONLY
See Also:
Constant Field Values
Method Detail

getArchive

public org.eclipse.birt.core.archive.IDocArchiveReader getArchive()

close

public void close()
close the report document, rlease all resources.


getName

public java.lang.String getName()
Returns:
the report document (archive) name

getDesignStream

public java.io.InputStream getDesignStream()
Returns:
a report design stream. This is useful for rerunning a report based on report document

getReportRunnable

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

Returns:
the runnable report design. It is available because a report document must be run with a report design

getParameterValues

public java.util.Map getParameterValues()
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.

getPageCount

public long getPageCount()
Returns:
the page count in the report. Used for supporting page-based viewing

getPageNumber

public long getPageNumber(java.lang.String bookmark)
Given a bookmark in a report, find the (first) page that the bookmark appears in (for hyperlinks to a bookmark)

Returns:
the page number that the instance appears first

getBookmarks

public java.util.List getBookmarks()
Returns:
a list of bookmark strings

getChildren

public java.util.List getChildren(java.lang.String tocNodeId)
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

public TOCNode findTOC(java.lang.String tocNodeId)
get the TOCNode have the id.

Parameters:
tocNodeId - the id of the toc.
Returns:
TOCNode with sucn an Id. NULL if not founded.

getGlobalVariables

public java.util.Map getGlobalVariables(java.lang.String option)
Returns:
a map for all the global variables defined in JavaScript or Java


Copyright © 2005 Actuate Corp. All rights reserved.