public final class DesignEngine extends java.lang.Object implements IDesignEngine
The design engine uses meta-data defined in an external file. This
file is defined by BIRT and should both be available and valid. However, if
an application wants to catch and handle errors associated with this file, it
can create and register an instance of IMetaLogger before
creating or opening the first report design. The logger is most useful for
test suites.
This is a wrapper class for the IDesignEngine. The new user should use the IDesignEngineFactory to create the IDesignEngine instead of use this class directly.
IMetaLogger,
MetaLogManager| 限定符和类型 | 字段和说明 |
|---|---|
protected static IDesignEngineFactory |
cachedFactory |
protected IDesignEngine |
engine
The implementation of the design engine.
|
protected static java.util.logging.Logger |
errorLogger
The logger for errors.
|
| 构造器和说明 |
|---|
DesignEngine(DesignConfig config)
Constructs a DesignEngine with the given platform config.
|
| 限定符和类型 | 方法和说明 |
|---|---|
IMetaDataDictionary |
getMetaData()
Gets the meta-data of the design engine.
|
static IMetaDataDictionary |
getMetaDataDictionary()
已过时。
|
static SessionHandle |
newSession(com.ibm.icu.util.ULocale locale)
已过时。
|
SessionHandle |
newSessionHandle(com.ibm.icu.util.ULocale locale)
Creates a new design session handle.
|
IReportDesign |
openDesign(java.lang.String fileName,
java.io.InputStream ins,
IModuleOption options)
Opens the report design.
|
void |
registerMetaLogger(IMetaLogger newLogger)
Registers a
IMetaLogger to record initialization errors. |
boolean |
removeMetaLogger(IMetaLogger logger)
Removes a
IMetaLogger. |
protected static final java.util.logging.Logger errorLogger
protected static IDesignEngineFactory cachedFactory
protected IDesignEngine engine
public DesignEngine(DesignConfig config)
config - the platform config.public SessionHandle newSessionHandle(com.ibm.icu.util.ULocale locale)
newSessionHandle 在接口中 IDesignEnginelocale - the user's locale. If null, uses the system
locale.SessionHandlepublic static SessionHandle newSession(com.ibm.icu.util.ULocale locale)
This method is not suggested to use. The user should use new DesignEngine(config).newSessionHandle() to create the session.
locale - the user's locale. If null, uses the system
locale.SessionHandlepublic IMetaDataDictionary getMetaData()
getMetaData 在接口中 IDesignEnginepublic static IMetaDataDictionary getMetaDataDictionary()
This method is not suggested to use. The user should use new DesignEngine(config).getMetaData() to get the metadata dictionary.
public void registerMetaLogger(IMetaLogger newLogger)
IMetaLogger to record initialization errors. The
logger will be notified of the errors during meta-data initialization.
The meta-data system will be initialized once (and only once). Loggers
should be registered before the first time a session is created so that
it can be notified of the logging actions.registerMetaLogger 在接口中 IDesignEnginenewLogger - the MetaLogger to be registered.removeMetaLogger(IMetaLogger)public boolean removeMetaLogger(IMetaLogger logger)
IMetaLogger. This method will remove the logger
from the list and close the logger if it has already been registered. The
logger will no longer be notified of the errors during metadata
initialization. Returns true if this logger manager
contained the specified logger.removeMetaLogger 在接口中 IDesignEnginelogger - the MetaLogger to be removed.true if this logger manager contained the specified
logger.registerMetaLogger(IMetaLogger)public IReportDesign openDesign(java.lang.String fileName, java.io.InputStream ins, IModuleOption options) throws DesignFileException
openDesign 在接口中 IDesignEnginefileName - the report file nameins - the input stream. Can be null.options - options to control the way to open the designDesignFileException - if the report file cannot be found or the file is invalid.Copyright © 2008 Actuate Corp. All rights reserved.