Package | Description |
---|---|
org.eclipse.birt.report.engine.api |
This is an application-writer's interface for using the BIRT report engine.
|
Modifier and Type | Class and Description |
---|---|
class |
UnsupportedFormatException |
Modifier and Type | Method and Description |
---|---|
static void |
DocumentUtil.copy(IArchiveFile source,
IArchiveFile target,
IReportRunnable runnable) |
IDatasetPreviewTask |
IReportEngine.createDatasetPreviewTask() |
IDatasetPreviewTask |
ReportEngine.createDatasetPreviewTask() |
IEngineTask |
IReportEngine.createEngineTask(java.lang.String taskName)
create an engine task
|
IEngineTask |
ReportEngine.createEngineTask(java.lang.String taskName) |
void |
IGetParameterDefinitionTask.evaluateDefaults()
Deprecated.
use getDefaultParameterValues() directly.
|
IExtractionResults |
IDatasetPreviewTask.execute()
execute the query and return the result set
|
IExtractionResults |
IDataExtractionTask.extract()
Redeclare this method in order to return IExtractionResults.
|
java.util.List<IBookmarkInfo> |
IReportDocumentHelper.getBookmarkInfos(java.util.Locale locale) |
static java.util.Collection<IBookmarkInfo> |
DocumentUtil.getBookmarks(IReportDocument document,
java.util.Locale locale) |
void |
HTMLServerImageHandler.getImage(java.io.OutputStream out,
java.lang.String imageDir,
java.lang.String imageID)
get image
|
java.util.List |
IDataExtractionTask.getMetaData()
Deprecated.
|
long |
IRenderTask.getPageCount()
Gets count of the pages that is output.
|
long |
IRenderTask.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.List |
IDataExtractionTask.getResultSetList()
returns the metadata corresponding to the data stored in the report
document, for the specific extraction level, i.e., report, daat set,
report item, or report item instance levels.
|
ITOCTree |
IRenderTask.getTOCTree()
Get the TOC tree
|
long |
IRenderTask.getTotalPage() |
IDocumentWriter |
IReportEngine.openDocumentWriter(IArchiveFile file)
creates a document writer that can write this archive file
|
IDocumentWriter |
ReportEngine.openDocumentWriter(IArchiveFile file)
creates a document writer that can write this archive file
|
IReportRunnable |
IReportEngine.openReportDesign(ReportDesignHandle designHandle)
Opens a report designHandle and creates a report design runnable.
|
IReportRunnable |
ReportEngine.openReportDesign(ReportDesignHandle designHandle)
opens a report designHandle and creates a report design runnable.
|
IReportRunnable |
IReportEngine.openReportDesign(java.lang.String designName)
Opens a report design file and creates a report design runnable.
|
IReportRunnable |
ReportEngine.openReportDesign(java.lang.String designName)
opens a report design file and creates a report design runnable.
|
IReportRunnable |
ReportEngine.openReportDesign(java.lang.String name,
java.io.InputStream designStream)
opens a report design stream and creates a report design runnable.
|
IReportRunnable |
IReportEngine.openReportDesign(java.lang.String name,
java.io.InputStream designStream,
IResourceLocator locator)
Opens a report design stream and creates a report design runnable.
|
IReportRunnable |
ReportEngine.openReportDesign(java.lang.String name,
java.io.InputStream designStream,
IResourceLocator locator)
opens a report design stream and creates a report design runnable.
|
IReportRunnable |
IReportEngine.openReportDesign(java.lang.String designName,
IResourceLocator locator)
Opens a report design file and creates a report design runnable.
|
IReportRunnable |
ReportEngine.openReportDesign(java.lang.String designName,
IResourceLocator locator)
opens a report design file and creates a report design runnable.
|
IReportDocument |
IReportEngine.openReportDocument(java.lang.String fileName)
Opens a report document and returns an IReportDocument object, from which
further information can be retrieved.
|
IReportDocument |
ReportEngine.openReportDocument(java.lang.String fileName)
opens a report document and returns an IReportDocument object, from which
further information can be retrieved.
|
IReportDocument |
IReportEngine.openReportDocument(java.lang.String systemId,
IDocArchiveReader archiveReader,
java.util.Map options)
Opens a report document and returns an IReportDocument object, from which
further information can be retrieved.
|
IReportDocument |
ReportEngine.openReportDocument(java.lang.String systemId,
IDocArchiveReader reader,
java.util.Map options)
opens a report document and returns an IReportDocument object, from which
further information can be retrieved.
|
IReportDocument |
IReportEngine.openReportDocument(java.lang.String fileName,
IResourceLocator locator)
Opens a report document and returns an IReportDocument object, from which
further information can be retrieved.
|
IReportDocument |
ReportEngine.openReportDocument(java.lang.String fileName,
IResourceLocator locator)
opens a report document and returns an IReportDocument object, from which
further information can be retrieved.
|
IReportDocument |
ReportEngine.openReportDocument(java.lang.String systemId,
java.lang.String fileName)
opens a report document and returns an IReportDocument object, from which
further information can be retrieved.
|
IReportDocument |
IReportEngine.openReportDocument(java.lang.String systemId,
java.lang.String fileName,
IResourceLocator locator)
Opens a report document and returns an IReportDocument object, from which
further information can be retrieved.
|
IReportDocument |
ReportEngine.openReportDocument(java.lang.String systemId,
java.lang.String fileName,
IResourceLocator locator)
opens a report document and returns an IReportDocument object, from which
further information can be retrieved.
|
void |
IRenderTask.render()
render the whole report document or an output format
|
void |
IRenderTask.render(InstanceID iid)
Deprecated.
A page which contains the instance can be rendered like this:
setInstanceID( instanceID ); render( ); |
void |
IRenderTask.render(long pageNumber)
Deprecated.
A page with speicfic page number can be rendered like this:
setPageNumber( pageNumber ); render( ); |
void |
IRenderTask.render(java.lang.String pageRange)
Deprecated.
A range of pages can be rendered like this:
setPageRange( pageRange ); render( ); |
void |
IRunAndRenderTask.run()
runs the task to generate report document or other output format
|
void |
IRunTask.run()
run this task.
|
void |
IRunTask.run(FolderArchive fArchive)
Deprecated.
|
void |
IRunTask.run(IDocArchiveWriter archive) |
void |
IRunTask.run(java.lang.String reportDocName)
runs the task to generate report document
|
void |
IRenderTask.setBookmark(java.lang.String bookmark)
Sets bookmark.
|
void |
IRenderTask.setInstanceID(InstanceID iid)
Sets id of instance.
|
void |
IRenderTask.setInstanceID(java.lang.String iid)
Sets id of instance which is a string type.
|
void |
IRenderTask.setPageNumber(long pageNumber)
Sets number of the page to be rendered.
|
void |
IRenderTask.setPageRange(java.lang.String pageRange)
Sets range of the pages to be rendered.
|
void |
IRenderTask.setReportlet(java.lang.String bookmark)
Sets reportlet by bookmark.
|
void |
IDocumentWriter.setRunnable(IReportRunnable runnable)
set a report runnable which can be used to update a report document
|
Copyright © 2014 OpenText Corp. All rights reserved.