public class ReportEngine extends java.lang.Object implements IReportEngine
org.eclipes.birt.report.engine.api.ReportRunner| 限定符和类型 | 字段和说明 |
|---|---|
protected IReportEngine |
engine
the report engine.
|
protected static java.util.logging.Logger |
logger
the logger
|
| 构造器和说明 |
|---|
ReportEngine(EngineConfig config)
Constructor.
|
| 限定符和类型 | 方法和说明 |
|---|---|
void |
changeLogLevel(java.util.logging.Level newLevel)
Change the log level to newLevel
|
IDataExtractionTask |
createDataExtractionTask(IReportDocument reportDocument)
creates a task that allows data extraction from a report document
|
IDatasetPreviewTask |
createDatasetPreviewTask() |
IEngineTask |
createEngineTask(java.lang.String taskName)
create an engine task
|
IGetParameterDefinitionTask |
createGetParameterDefinitionTask(IReportRunnable reportRunnable)
creates an engine task for obtaining report parameter definitions
|
IGetParameterDefinitionTask |
createGetParameterDefinitionTask(IRunnable reportRunnable)
creates an engine task for obtaining report parameter definitions
|
IRenderTask |
createRenderTask(IReportDocument reportDocument)
creates a task that renders the report to a specific output format.
|
IRenderTask |
createRenderTask(IReportDocument reportDocument,
IReportRunnable reportRunnable)
create a task that renders the report to a specific output format.
|
IRunAndRenderTask |
createRunAndRenderTask(IReportRunnable reportRunnable)
creates an engine task for running and rendering report directly to
output format
|
IRunTask |
createRunTask(IReportRunnable reportRunnable)
creates a task to run a report to generate a report document
|
void |
destroy()
shuts down the report engine
|
EngineConfig |
getConfig()
returns the engine configuration object
|
DataExtractionFormatInfo[] |
getDataExtractionFormatInfo()
Returns data extraction extension information.
|
EmitterInfo[] |
getEmitterInfo()
Return all the emitter information which BIRT Engine can load.
|
java.util.logging.Logger |
getLogger()
get the logger used by report engine
|
java.lang.String |
getMIMEType(java.lang.String format)
the MIME type for the specific formatted supported by the extension.
|
java.lang.Object |
getRootScope()
get the root scope used by the engine
|
java.lang.String[] |
getSupportedFormats()
returns all supported output formats through BIRT engine emitter
extensions
|
java.lang.String |
getVersion()
get the BIRT version
|
IDocumentWriter |
openDocumentWriter(org.eclipse.birt.core.archive.compound.IArchiveFile file)
creates a document writer that can write this archive file
|
IReportRunnable |
openReportDesign(java.io.InputStream designStream)
opens a report design stream and creates a report design runnable.
|
IReportRunnable |
openReportDesign(org.eclipse.birt.report.model.api.ReportDesignHandle designHandle)
opens a report designHandle and creates a report design runnable.
|
IReportRunnable |
openReportDesign(java.lang.String designName)
opens a report design file and creates a report design runnable.
|
IReportRunnable |
openReportDesign(java.lang.String name,
java.io.InputStream designStream)
opens a report design stream and creates a report design runnable.
|
IReportRunnable |
openReportDesign(java.lang.String name,
java.io.InputStream designStream,
org.eclipse.birt.report.model.api.IResourceLocator locator)
opens a report design stream and creates a report design runnable.
|
IReportRunnable |
openReportDesign(java.lang.String name,
java.io.InputStream designStream,
java.util.Map options)
open the report design and return the runnable
|
IReportRunnable |
openReportDesign(java.lang.String designName,
org.eclipse.birt.report.model.api.IResourceLocator locator)
opens a report design file and creates a report design runnable.
|
IReportDocument |
openReportDocument(java.lang.String fileName)
opens a report document and returns an IReportDocument object, from which
further information can be retrieved.
|
IReportDocument |
openReportDocument(java.lang.String systemId,
org.eclipse.birt.core.archive.IDocArchiveReader reader,
java.util.Map options)
opens a report document and returns an IReportDocument object, from which
further information can be retrieved.
|
IReportDocument |
openReportDocument(java.lang.String fileName,
org.eclipse.birt.report.model.api.IResourceLocator locator)
opens a report document and returns an IReportDocument object, from which
further information can be retrieved.
|
IReportDocument |
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 |
openReportDocument(java.lang.String systemId,
java.lang.String fileName,
org.eclipse.birt.report.model.api.IResourceLocator locator)
opens a report document and returns an IReportDocument object, from which
further information can be retrieved.
|
IReportDocument |
openReportDocument(java.lang.String systemId,
java.lang.String fileName,
java.util.Map options)
opens a report document and returns an IReportDocument object, from which
further information can be retrieved.
|
void |
setLogger(java.util.logging.Logger logger)
set the logger used by report engine.
|
void |
shutdown()
已过时。
|
protected static java.util.logging.Logger logger
protected IReportEngine engine
public ReportEngine(EngineConfig config)
config - an engine configuration object used to configure the enginepublic java.lang.Object getRootScope()
getRootScope 在接口中 IReportEnginepublic void changeLogLevel(java.util.logging.Level newLevel)
changeLogLevel 在接口中 IReportEnginenewLevel - -
new log levelpublic EngineConfig getConfig()
getConfig 在接口中 IReportEnginepublic IReportRunnable openReportDesign(java.lang.String designName) throws EngineException
openReportDesign 在接口中 IReportEnginedesignName - the full path of the report design fileEngineException - throwed when the input file does not exist, or the file is
invalidpublic IReportRunnable openReportDesign(org.eclipse.birt.report.model.api.ReportDesignHandle designHandle) throws EngineException
openReportDesign 在接口中 IReportEnginedesignHandle - EngineExceptionpublic IReportRunnable openReportDesign(java.io.InputStream designStream) throws EngineException
openReportDesign 在接口中 IReportEnginedesignStream - the report design input streamEngineException - throwed when the input stream is null, or the stream does not
yield a valid report designpublic IReportRunnable openReportDesign(java.lang.String name, java.io.InputStream designStream) throws EngineException
openReportDesign 在接口中 IReportEnginename - system id of the report designdesignStream - input stream of the report designEngineException - throwed when the input stream is null, or the stream does not
yield a valid report designpublic IRunAndRenderTask createRunAndRenderTask(IReportRunnable reportRunnable)
createRunAndRenderTask 在接口中 IReportEnginereportRunnable - the runnable report design objectpublic IGetParameterDefinitionTask createGetParameterDefinitionTask(IRunnable reportRunnable)
createGetParameterDefinitionTask 在接口中 IReportEnginereportRunnable - the runnable report design objectpublic IGetParameterDefinitionTask createGetParameterDefinitionTask(IReportRunnable reportRunnable)
createGetParameterDefinitionTask 在接口中 IReportEnginereportRunnable - the runnable report design objectpublic java.lang.String[] getSupportedFormats()
getSupportedFormats 在接口中 IReportEnginepublic EmitterInfo[] getEmitterInfo()
getEmitterInfo 在接口中 IReportEnginepublic java.lang.String getMIMEType(java.lang.String format)
getMIMEType 在接口中 IReportEngineformat - the output formatextensionID - the extension ID, which could be null if only one plugin
supports the output formatpublic void destroy()
destroy 在接口中 IReportEnginepublic IRunTask createRunTask(IReportRunnable reportRunnable)
createRunTask 在接口中 IReportEnginereportRunnable - the runnable report design objectpublic IRenderTask createRenderTask(IReportDocument reportDocument)
createRenderTask 在接口中 IReportEnginereportDocument - a handle to an IReportDocument objectpublic IReportDocument openReportDocument(java.lang.String fileName) throws EngineException
openReportDocument 在接口中 IReportEnginefileName - the report document name. report document is an archive in
BIRT.EngineException - throwed when the report document archive does not exist, or
the file is not a valud report documentpublic IDataExtractionTask createDataExtractionTask(IReportDocument reportDocument)
createDataExtractionTask 在接口中 IReportEnginereportDocument - a handle to an IReportDocument objectpublic void shutdown()
shutdown 在接口中 IReportEnginepublic IReportDocument openReportDocument(java.lang.String systemId, java.lang.String fileName) throws EngineException
openReportDocument 在接口中 IReportEnginesystemId - the system id the opend document. It is used to access the resources with
relative path in the report document. If it is NULL, a saved one is used.fileName - the report document name. report document is an archive in
BIRT.EngineException - throwed when the report document archive does not exist, or
the file is not a valid report documentpublic IReportRunnable openReportDesign(java.lang.String designName, org.eclipse.birt.report.model.api.IResourceLocator locator) throws EngineException
openReportDesign 在接口中 IReportEnginedesignName - the full path of the report design filelocator - the resource locator used to locate files referenced in the designEngineException - throwed when the input file does not exist, or the file is
invalidpublic IReportRunnable openReportDesign(java.lang.String name, java.io.InputStream designStream, org.eclipse.birt.report.model.api.IResourceLocator locator) throws EngineException
openReportDesign 在接口中 IReportEnginename - system id of the report designdesignStream - input stream of the report designlocator - the resource locator used to locate files referenced in the designEngineException - throwed when the input stream is null, or the stream does not
yield a valid report designpublic IReportRunnable openReportDesign(java.lang.String name, java.io.InputStream designStream, java.util.Map options) throws EngineException
openReportDesign 在接口中 IReportEnginename - system id of the report design.designStream - input stream of the report desgin.options - options used to parse the design.EngineExceptionModelOptionspublic IReportDocument openReportDocument(java.lang.String fileName, org.eclipse.birt.report.model.api.IResourceLocator locator) throws EngineException
openReportDocument 在接口中 IReportEnginefileName - the report document name. report document is an archive in
BIRT.locator - the resource locator used to locate files referenced in the designEngineException - throwed when the report document archive does not exist, or
the file is not a valud report documentpublic IReportDocument openReportDocument(java.lang.String systemId, java.lang.String fileName, org.eclipse.birt.report.model.api.IResourceLocator locator) throws EngineException
openReportDocument 在接口中 IReportEnginesystemId - the system id the opend document. It is used to access the resources with
relative path in the report document. If it is NULL, a saved one is used.fileName - the report document name. report document is an archive in
BIRT.locator - the resource locator used to locate files referenced in the designEngineException - throwed when the report document archive does not exist, or
the file is not a valud report documentpublic IReportDocument openReportDocument(java.lang.String systemId, java.lang.String fileName, java.util.Map options) throws EngineException
openReportDocument 在接口中 IReportEnginesystemId - the system id the opend document. It is used to access the resources with
relative path in the report document. If it is NULL, a saved one is used.fileName - the report document name. report document is an archive in
BIRT.options - Map defines the options used to parse the design file.EngineException - throwed when the report document archive does not exist, or
the file is not a valid report documentpublic IReportDocument openReportDocument(java.lang.String systemId, org.eclipse.birt.core.archive.IDocArchiveReader reader, java.util.Map options) throws EngineException
openReportDocument 在接口中 IReportEnginesystemId - the system id the opend document. It is used to access the resources with
relative path in the report document. If it is NULL, a saved one is used.reader - a report archive for readingoptions - Map defines the options used to parse the design file.EngineException - throwed when the report document archive does not exist, or
the file is not a valid report documentpublic java.util.logging.Logger getLogger()
getLogger 在接口中 IReportEnginepublic void setLogger(java.util.logging.Logger logger)
setLogger 在接口中 IReportEnginelogger - public IRenderTask createRenderTask(IReportDocument reportDocument, IReportRunnable reportRunnable)
createRenderTask 在接口中 IReportEnginereportDocument - a handle to an IReportDocument objectreportRunnable - the runnable report design objectpublic DataExtractionFormatInfo[] getDataExtractionFormatInfo()
getDataExtractionFormatInfo 在接口中 IReportEnginepublic IDocumentWriter openDocumentWriter(org.eclipse.birt.core.archive.compound.IArchiveFile file) throws EngineException
openDocumentWriter 在接口中 IReportEnginefile - the archive fileEngineExceptionpublic java.lang.String getVersion()
getVersion 在接口中 IReportEnginepublic IEngineTask createEngineTask(java.lang.String taskName) throws EngineException
IReportEnginecreateEngineTask 在接口中 IReportEnginetaskName - the extension name to identify a taskEngineExceptionpublic IDatasetPreviewTask createDatasetPreviewTask() throws EngineException
createDatasetPreviewTask 在接口中 IReportEngineEngineExceptionCopyright © 2008 Actuate Corp. All rights reserved.