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 ActionCreates an empty action structure.static AggregationArgumentCreates an aggregation argument for computed column.static CachedMetaDataCreates an empty data set cached meta-data structure.static CalculationArgumentCreates a new calculation argument structure.static ColumnHintCreates an empty column hint structure.static ComputedColumnCreates an empty computed column structure.static ConfigVariableCreates an empty config variable structure.static DimensionConditionCreates an empty cube join condition structure.static CustomColorCreates an empty custom color structure.static DataSetParameterCreates an empty data-set parameter structure.static DimensionJoinConditionCreates an empty dimension join condition structure.static EmbeddedImageCreates an empty embedded image structure.static EmbeddedImagecreateEmbeddedImage(EmbeddedImageHandle baseImage) Deprecated.static ExtendedPropertyCreates an empty extended property structure.static FilterConditionCreates an empty filter condition structure.static HideRuleCreates an empty hide rule structure.static HighlightRuleCreates an empty highlight rule structure.static IncludedCssStyleSheetCreate an empty include css style sheet ststructure.static IncludedLibraryCreates an empty include library structure.static IncludeScriptCreates an empty include script structure.static JoinConditionCreates an empty join condition structure.static LevelAttributeCreates an attribute for TabularLevel.static MapRuleCreates an empty map rule structure.static OdaDataSetParameterCreates an empty oda-data-set parameter strcuture.static OdaDesignerStateCreates an empty oda designer state.static OdaLevelAttributeCreates an attribute for OdaLevel.static OdaResultSetColumnCreates an empty oda result set column structure.static ParamBindingCreates an empty parameter binding structure.static PropertyMaskCreates an empty property mask structure.static ResultSetColumnCreates an empty result set column structure.static RuleCreates a Rule structure.static ScriptLibCreates an empty join condition structure.static SearchKeyCreates an empty search key structure.static SelectionChoiceCreates an empty selection choice structure.static SortHintCreates a new sort hint.static SortKeyCreates an empty sort key structure.static TimeIntervalCreates a new time interval.static TOCCreate TOC structure.static TOCCreate TOC structure with expression value.static voidmakeUniqueNameComputedColumn(DesignElementHandle element, ComputedColumn newColumn) Makes a unique name for computed column.static ComputedColumnnewComputedColumn(DesignElementHandle element, String newName) Creates a bound data column name with the unique column name.static EmbeddedImagenewEmbeddedImageFrom(EmbeddedImageHandle baseImage, String name, ModuleHandle targetModule) Creates an embedded image from another library embedded image.static EmbeddedImagenewEmbeddedImageFrom(EmbeddedImageHandle baseImage, ModuleHandle targetModule) Creates an embedded image from another library embedded image.static FormatValueCreates 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 thebaseImageis 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 thebaseImageis 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
newNameis "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
newNameis unique, the name in the return value isnewName. Otherwise the newly created name follows the above schema. It can also benullif the given element do not support bound data column property. - Throws:
IllegalArgumentException- if thenewNameisnull.
-
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)