Package org.eclipse.birt.report.model.api.metadata

Defines the elements, properties, types, structures and slots in the Report Object Model.

Package Specification

The Design Engine is based on a series of definitions that provide "meta-data" about the various objects that make up a report design. The definitions include:

Property types
define data types for properties such as string, URI, expression, etc.
Properties
define the attributes of report elements.
Report elements
define objects that combine to describe the report.
Choices
available to properties such as colors, text alignment and other attributes with a fixed set of values.
Slots
define how elements contain other elements.
Standard styles
defined by the product itself.

The definition information resides in the meta-data dictionary. There is one instance of the dictionary shared by all designs. The meta-data is invariant across designs.

Related Documentation

See Also:

IElementDefn, IMetaDataDictionary

Interface Summary

Interface	Description
IArgumentInfo	Represents the definition of argument.
IArgumentInfoList	Represents an optional argument list of a method.
IChoice	Describes the options for a property value.
IChoiceSet	Represents a set of choices on a predefined or user defined property type or property definition.
IClassInfo	Represents the script object definition.
IColorConstants	The interface for constants of colors used in BIRT.
IElementDefn	Interface for a report element definition.
IElementPropertyDefn	Interface of the Meta-data information for an element property or an extension model property.
ILocalizableInfo	Represents the abstract definition which can be localized.
IMemberInfo	Represents the definition of class member.
IMetaDataDictionary	Global, shared dictionary of design meta data.
IMetaLogger	Interface to handle meta-data errors during initialization.
IMethodInfo	Represents the method information for both class and element.
IObjectDefn	Base Interface for methods common to elements and structures.
IPredefinedStyle	BIRT defines a fixed set of predefined styles.
IPropertyDefn	Base Interface for both element property, extension model property and structure member definitions.
IPropertyType	Base class for the meta-data for property types.
ISlotDefn	Interface for the definition of a slot within an element.
IStructureDefn	Interface for the definition of a property structure: an object that is "managed" by the model to allow generic member access and undo/redo support for updates.
ITemplateMethodInfo	Represents the method information that can provide code template.
MetaDataConstants	Provides constants used in the meta-data package.

Class Summary

Class	Description
ArgumentInfo	Represents the definition of argument.
ArgumentInfoList	Represents an optional argument list of a method.
ClassInfo	Represents the script object definition.
DimensionValue	Representation of a dimension property value.
MemberInfo	Represents the definition of class member.
MethodInfo	Represents the method information for both class and element.
UserChoice	Describes the user defined choices for a user defined property.

Exception Summary

Exception	Description
MetaDataReaderException	Exception thrown if an error occurs when reading the meta-data description file or the building the meta-data description.
PropertyValueException	Indicates an invalid property value.
ValidationValueException	Indicates an invalid validation value.