Package org.eclipse.birt.report.model.api.elements.structures

Defines the structure types in Model system.

Package Specification

In ROM, some properties are composed of multiple values. For example, an Action (hyperlink) property has a URL, a target window name, and more. A property structure allows a single property to provide a set of related values. A property structure is just like a structure in C or C++, and is similar to an object in Java or JavaScript. Structures have no members, they just have a set of properties.

Structures also have a name. ROM uses the structure name be to determine the properties that make up the structure. Some structure names are ¡°Action¡±,¡°CustomColor¡±, etc.

¡¡

¡¡

¡¡

Class Summary

Class	Description
Action	The Action structure defines a hyperlink.
AggregationArgument	AggregationArgument.
CachedMetaData	Structure used to cache data set information that include output column information when it gets from databases, input/output parameter definitions.
CalculationArgument	CalculationArgument.
ColumnHint	This class represents one column hint used by data sets.
ComputedColumn	Represents one computed column.
ConfigVariable	This class represents a configuration variable in the report's config variable list.
CustomColor	Represents an custom color in the report's color palette.The use-defined color has a unique name and a valid RGB value for render.
DataSetParameter	Represents the parameter for ODA drivers.
DateFormatValue	The format value for the data.
DateTimeFormatValue	The format value for the data-time.
DimensionCondition	The DimensionCondition structure defines a list of join conditions between cube and hierarchy.
DimensionJoinCondition	Represents a dimension join condition in the DimensionCondition.
EmbeddedImage	Represents an embedded image.
ExtendedProperty	This class represents one Extended property.
FilterCondition	Represents one filter in the filter list of List, Table or their Groups.
FormatValue	The abstract value for the format of string, data-time and number.
HideRule	Implements hide rules of a ReportItem.
HighlightRule	Represents a highlight rule that says how a data item should appear based on the value within it.
IncludedCssStyleSheet	Included css style sheet structure
IncludedLibrary	This class represents one include library of report design.
IncludeScript	This class represents a include script.
JoinCondition	Represents a condition used for joint data set.
LevelAttribute	This class represents one attribute of the level element.
MapRule	This class represents a style mapping rule: a translation of a database value into a set of display values.
NumberFormatValue	The format value for the number like integer, float, etc.
OdaDataSetParameter	Represents the parameter for ODA drivers.
OdaDesignerState	The structure of the Oda designer state.
OdaLevelAttribute	This class represents one attribute of the level element.
OdaResultSetColumn
ParamBinding	This class presents the parameter binding that bind data set input parameter to expression by position.
ParameterFormatValue	Represents the format for the default value of scalar parameter.
PropertyBinding	Represents the property binding structure.
PropertyMask	This class provides property masks of system or user defined properties.
ResultSetColumn	This class represents one column in the result set.
Rule	This class represents one rule.
ScriptLib	Represents a jar file used for script handle event.
SearchKey	Structure for optional list of search criteria.
SelectionChoice	This class is a structure for selection-list in ScalarParameter item.
SortHint	This class represents a sort hint.
SortKey	This class represents a sort entry for a table or list item, it defines the column and sort direction pair.
StringFormatValue	The format value for the string type.
StyleRule	Base class for highlight and map rules in the style.
TimeFormatValue	The format value for the time.
TimeInterval	Time interval structure.
TOC	The TOC structure defines a TOC.