|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.DesignEngine
Represents the BIRT design engine as a whole. Used to create new designs or open existing designs.
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.
IMetaLogger
,
MetaLogManager
Constructor Summary | |
DesignEngine()
|
Method Summary | |
static IMetaDataDictionary |
getMetaDataDictionary()
Gets the meta-data dictionary of the design engine. |
static void |
initialize(java.io.InputStream is)
Initializes the meta-data system and loads all extensions which implements the extension pointers the model defines. |
static void |
initialize(java.lang.String defnFileName)
Initializes the meta-data system and loads all extensions which implements the extension pointers the model defines. |
static SessionHandle |
newSession(java.util.Locale locale)
Creates a new design session handle. |
static ReportDesignHandle |
openDesign(java.lang.String fileName)
Deprecated. |
static ReportDesignHandle |
openDesign(java.lang.String fileName,
java.io.InputStream is)
Deprecated. |
static void |
registerMetaLogger(IMetaLogger newLogger)
Registers a IMetaLogger to record initialization errors. |
static boolean |
removeMetaLogger(IMetaLogger logger)
Removes a IMetaLogger . |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DesignEngine()
Method Detail |
public static void initialize(java.lang.String defnFileName) throws MetaDataReaderException
defnFileName
- name and location of the "rom.def" file that provides the
meta-data for the system
MetaDataReaderException
- if error occurs during read the meta-data file.public static void initialize(java.io.InputStream is) throws MetaDataReaderException
is
- stream for reading the "rom.def" file that provides the
meta-data for the system
MetaDataReaderException
- if error occurs during read the meta-data file.public static SessionHandle newSession(java.util.Locale locale)
locale
- the user's locale. If null
, uses the system
locale.
SessionHandle
public static IMetaDataDictionary getMetaDataDictionary()
public static ReportDesignHandle openDesign(java.lang.String fileName) throws DesignFileException
fileName
- the name of the file to open.
DesignFileException
- If the file is not found, or the file contains fatal errors.public static ReportDesignHandle openDesign(java.lang.String fileName, java.io.InputStream is) throws DesignFileException
fileName
- the name of the file to open. If null
, the
design will be treated as a new design, and will be saved to a
different file.is
- the stream to read the design
DesignFileException
- If the file is not found, or the file contains fatal errors.public static 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.
newLogger
- the MetaLogger
to be registered.removeMetaLogger(IMetaLogger)
public static 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.
logger
- the MetaLogger
to be removed.
true
if this logger manager contained the
specified logger.registerMetaLogger(IMetaLogger)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |