Class StructureFactory
java.lang.Object
org.eclipse.birt.report.model.api.StructureFactory
Provides the factory method to create empty structures.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Action
Creates an empty action structure.static AggregationArgument
Creates an aggregation argument for computed column.static CachedMetaData
Creates an empty data set cached meta-data structure.static CalculationArgument
Creates a new calculation argument structure.static ColumnHint
Creates an empty column hint structure.static ComputedColumn
Creates an empty computed column structure.static ConfigVariable
Creates an empty config variable structure.static DimensionCondition
Creates an empty cube join condition structure.static CustomColor
Creates an empty custom color structure.static DataSetParameter
Creates an empty data-set parameter structure.static DimensionJoinCondition
Creates an empty dimension join condition structure.static EmbeddedImage
Creates an empty embedded image structure.static EmbeddedImage
createEmbeddedImage
(EmbeddedImageHandle baseImage) Deprecated.static ExtendedProperty
Creates an empty extended property structure.static FilterCondition
Creates an empty filter condition structure.static HideRule
Creates an empty hide rule structure.static HighlightRule
Creates an empty highlight rule structure.static IncludedCssStyleSheet
Create an empty include css style sheet ststructure.static IncludedLibrary
Creates an empty include library structure.static IncludeScript
Creates an empty include script structure.static JoinCondition
Creates an empty join condition structure.static LevelAttribute
Creates an attribute for TabularLevel.static MapRule
Creates an empty map rule structure.static OdaDataSetParameter
Creates an empty oda-data-set parameter strcuture.static OdaDesignerState
Creates an empty oda designer state.static OdaLevelAttribute
Creates an attribute for OdaLevel.static OdaResultSetColumn
Creates an empty oda result set column structure.static ParamBinding
Creates an empty parameter binding structure.static PropertyMask
Creates an empty property mask structure.static ResultSetColumn
Creates an empty result set column structure.static Rule
Creates a Rule structure.static ScriptLib
Creates an empty join condition structure.static SearchKey
Creates an empty search key structure.static SelectionChoice
Creates an empty selection choice structure.static SortHint
Creates a new sort hint.static SortKey
Creates an empty sort key structure.static TimeInterval
Creates a new time interval.static TOC
Create TOC structure.static TOC
Create TOC structure with expression value.static void
makeUniqueNameComputedColumn
(DesignElementHandle element, ComputedColumn newColumn) Makes a unique name for computed column.static ComputedColumn
newComputedColumn
(DesignElementHandle element, String newName) Creates a bound data column name with the unique column name.static EmbeddedImage
newEmbeddedImageFrom
(EmbeddedImageHandle baseImage, String name, ModuleHandle targetModule) Creates an embedded image from another library embedded image.static EmbeddedImage
newEmbeddedImageFrom
(EmbeddedImageHandle baseImage, ModuleHandle targetModule) Creates an embedded image from another library embedded image.static FormatValue
Creates a new format value structure.
-
Constructor Details
-
StructureFactory
public StructureFactory()
-
-
Method Details
-
createCachedMetaData
Creates an empty data set cached meta-data structure.- Returns:
- an empty data set cached meta-data structure.
-
createComputedColumn
Creates an empty computed column structure.- Returns:
- an empty computed column structure
-
createAction
Creates an empty action structure.- Returns:
- an empty action structure.
-
createConfigVar
Creates an empty config variable structure.- Returns:
- an empty config variable structure
-
createCustomColor
Creates an empty custom color structure.- Returns:
- an empty custom color structure
-
createDataSetParameter
Creates an empty data-set parameter structure.- Returns:
- an empty data-set parameter structure
-
createOdaDataSetParameter
Creates an empty oda-data-set parameter strcuture.- Returns:
- an empty oda-data-set parameter
-
createEmbeddedImage
Creates an empty embedded image structure.- Returns:
- an empty embedded image structure
-
createFilterCond
Creates an empty filter condition structure.- Returns:
- an empty filter condition structure
-
createHideRule
Creates an empty hide rule structure.- Returns:
- an empty hide rule structure
-
createIncludeScript
Creates an empty include script structure.- Returns:
- an empty include script structure
-
createIncludeLibrary
Creates an empty include library structure.- Returns:
- an empty include library structure
-
createIncludedCssStyleSheet
Create an empty include css style sheet ststructure.- Returns:
- an empty include css style sheet structure.
-
createParamBinding
Creates an empty parameter binding structure.- Returns:
- an empty parameter binding structure
-
createPropertyMask
Creates an empty property mask structure.- Returns:
- an empty property mask structure
-
createResultSetColumn
Creates an empty result set column structure.- Returns:
- an empty result set column structure
-
createOdaResultSetColumn
Creates an empty oda result set column structure.- Returns:
- an empty result set column structure
-
createSearchKey
Creates an empty search key structure.- Returns:
- an empty search key structure
-
createSelectionChoice
Creates an empty selection choice structure.- Returns:
- an empty selection choice structure
-
createSortKey
Creates an empty sort key structure.- Returns:
- an empty sort key structure
-
createColumnHint
Creates an empty column hint structure.- Returns:
- an empty column hint structure
-
createHighlightRule
Creates an empty highlight rule structure.- Returns:
- an empty highlight rule structure
-
createMapRule
Creates an empty map rule structure.- Returns:
- an empty map rule structure
-
createExtendedProperty
Creates an empty extended property structure.- Returns:
- an empty extended property structure
-
createJoinCondition
Creates an empty join condition structure.- Returns:
- an empty join condition structure
-
createScriptLib
Creates an empty join condition structure.- Returns:
- an empty join condition structure
-
createOdaDesignerState
Creates an empty oda designer state.- Returns:
- an empty oda designer state.
-
createEmbeddedImage
Creates an embedded image from another library embedded image.- Parameters:
baseImage
-- Returns:
- the created embedded image
-
newEmbeddedImageFrom
public static EmbeddedImage newEmbeddedImageFrom(EmbeddedImageHandle baseImage, String name, ModuleHandle targetModule) throws LibraryException Creates an embedded image from another library embedded image. The name of the return embedded image fully depends onname
.- Parameters:
baseImage
- the base imagename
- the name of the return embedded imagetargetModule
- the target module that is inserted to- Returns:
- the created embedded image
- Throws:
LibraryException
- if the library has thebaseImage
is not included in thetargetModule
-
newEmbeddedImageFrom
public static EmbeddedImage newEmbeddedImageFrom(EmbeddedImageHandle baseImage, ModuleHandle targetModule) throws LibraryException Creates an embedded image from another library embedded image. This method creates the embedded image name automatically.- Parameters:
baseImage
- the base imagetargetModule
- the target module that is inserted to- Returns:
- the created embedded image
- Throws:
LibraryException
- if the library has thebaseImage
is not included in thetargetModule
-
newComputedColumn
Creates a bound data column name with the unique column name. The new name is given as "newName_[number]".For example, if the
newName
is "column" and this is duplicate, then the name of return column is: "column_1".- Parameters:
element
- the element on which computed column will be addednewName
- the default column name- Returns:
- a bound data column. If the
newName
is unique, the name in the return value isnewName
. Otherwise the newly created name follows the above schema. It can also benull
if the given element do not support bound data column property. - Throws:
IllegalArgumentException
- if thenewName
isnull
.
-
makeUniqueNameComputedColumn
public static void makeUniqueNameComputedColumn(DesignElementHandle element, ComputedColumn newColumn) Makes a unique name for computed column. It checks all the existing computed columns in given element, such as report items, scalar parameters and group elements. If any one has a duplicate column name with thenewColumn
, it will generate a unique column name for newColumn and rename it; Otherwise, do nothing.This possible rename action is not undoable.- Parameters:
element
- the element whose existing computed columns needs to be checked or newColumn want to be insertednewColumn
- the computed column to be checked and renamed
-
createTOC
Create TOC structure.- Returns:
- toc object
-
createTOC
Create TOC structure with expression value.- Parameters:
expression
- expression value- Returns:
- toc object
-
createCubeJoinCondition
Creates an empty cube join condition structure.- Returns:
- an empty cube join condition structure.
-
createDimensionJoinCondition
Creates an empty dimension join condition structure.- Returns:
- an empty dimension join condition structure.
-
createRule
Creates a Rule structure.- Returns:
- a rule structure
-
createLevelAttribute
Creates an attribute for TabularLevel.- Returns:
- a level attribute
-
createOdaLevelAttribute
Creates an attribute for OdaLevel.- Returns:
- a level attribute
-
createAggregationArgument
Creates an aggregation argument for computed column.- Returns:
- an aggregation argument
-
createSortHint
Creates a new sort hint.- Returns:
- a sort hint.
-
createTimeInterval
Creates a new time interval.- Returns:
- a time interval.
-
newFormatValue
Creates a new format value structure.- Returns:
- the format value created.
-
createCalculationArgument
Creates a new calculation argument structure.- Returns:
- the calculation argument created
-
newEmbeddedImageFrom(EmbeddedImageHandle, String, ModuleHandle)