Class StructureFactory
- java.lang.Object
-
- org.eclipse.birt.report.model.api.StructureFactory
-
public class StructureFactory extends java.lang.ObjectProvides the factory method to create empty structures.
-
-
Constructor Summary
Constructors Constructor Description StructureFactory()
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static ActioncreateAction()Creates an empty action structure.static AggregationArgumentcreateAggregationArgument()Creates an aggregation argument for computed column.static CachedMetaDatacreateCachedMetaData()Creates an empty data set cached meta-data structure.static CalculationArgumentcreateCalculationArgument()Creates a new calculation argument structure.static ColumnHintcreateColumnHint()Creates an empty column hint structure.static ComputedColumncreateComputedColumn()Creates an empty computed column structure.static ConfigVariablecreateConfigVar()Creates an empty config variable structure.static DimensionConditioncreateCubeJoinCondition()Creates an empty cube join condition structure.static CustomColorcreateCustomColor()Creates an empty custom color structure.static DataSetParametercreateDataSetParameter()Creates an empty data-set parameter structure.static DimensionJoinConditioncreateDimensionJoinCondition()Creates an empty dimension join condition structure.static EmbeddedImagecreateEmbeddedImage()Creates an empty embedded image structure.static EmbeddedImagecreateEmbeddedImage(EmbeddedImageHandle baseImage)static ExtendedPropertycreateExtendedProperty()Creates an empty extended property structure.static FilterConditioncreateFilterCond()Creates an empty filter condition structure.static HideRulecreateHideRule()Creates an empty hide rule structure.static HighlightRulecreateHighlightRule()Creates an empty highlight rule structure.static IncludedCssStyleSheetcreateIncludedCssStyleSheet()Create an empty include css style sheet ststructure.static IncludedLibrarycreateIncludeLibrary()Creates an empty include library structure.static IncludeScriptcreateIncludeScript()Creates an empty include script structure.static JoinConditioncreateJoinCondition()Creates an empty join condition structure.static LevelAttributecreateLevelAttribute()Creates an attribute for TabularLevel.static MapRulecreateMapRule()Creates an empty map rule structure.static OdaDataSetParametercreateOdaDataSetParameter()Creates an empty oda-data-set parameter strcuture.static OdaDesignerStatecreateOdaDesignerState()Creates an empty oda designer state.static OdaLevelAttributecreateOdaLevelAttribute()Creates an attribute for OdaLevel.static OdaResultSetColumncreateOdaResultSetColumn()Creates an empty oda result set column structure.static ParamBindingcreateParamBinding()Creates an empty parameter binding structure.static PropertyMaskcreatePropertyMask()Creates an empty property mask structure.static ResultSetColumncreateResultSetColumn()Creates an empty result set column structure.static RulecreateRule()Creates a Rule structure.static ScriptLibcreateScriptLib()Creates an empty join condition structure.static SearchKeycreateSearchKey()Creates an empty search key structure.static SelectionChoicecreateSelectionChoice()Creates an empty selection choice structure.static SortHintcreateSortHint()Creates a new sort hint.static SortKeycreateSortKey()Creates an empty sort key structure.static TimeIntervalcreateTimeInterval()Creates a new time interval.static TOCcreateTOC()Create TOC structure.static TOCcreateTOC(java.lang.String expression)Create TOC structure with expression value.static voidmakeUniqueNameComputedColumn(DesignElementHandle element, ComputedColumn newColumn)Makes a unique name for computed column.static ComputedColumnnewComputedColumn(DesignElementHandle element, java.lang.String newName)Creates a bound data column name with the unique column name.static EmbeddedImagenewEmbeddedImageFrom(EmbeddedImageHandle baseImage, java.lang.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 FormatValuenewFormatValue()Creates a new format value structure.
-
-
-
Method Detail
-
createCachedMetaData
public static CachedMetaData createCachedMetaData()
Creates an empty data set cached meta-data structure.- Returns:
- an empty data set cached meta-data structure.
-
createComputedColumn
public static ComputedColumn createComputedColumn()
Creates an empty computed column structure.- Returns:
- an empty computed column structure
-
createAction
public static Action createAction()
Creates an empty action structure.- Returns:
- an empty action structure.
-
createConfigVar
public static ConfigVariable createConfigVar()
Creates an empty config variable structure.- Returns:
- an empty config variable structure
-
createCustomColor
public static CustomColor createCustomColor()
Creates an empty custom color structure.- Returns:
- an empty custom color structure
-
createDataSetParameter
public static DataSetParameter createDataSetParameter()
Creates an empty data-set parameter structure.- Returns:
- an empty data-set parameter structure
-
createOdaDataSetParameter
public static OdaDataSetParameter createOdaDataSetParameter()
Creates an empty oda-data-set parameter strcuture.- Returns:
- an empty oda-data-set parameter
-
createEmbeddedImage
public static EmbeddedImage createEmbeddedImage()
Creates an empty embedded image structure.- Returns:
- an empty embedded image structure
-
createFilterCond
public static FilterCondition createFilterCond()
Creates an empty filter condition structure.- Returns:
- an empty filter condition structure
-
createHideRule
public static HideRule createHideRule()
Creates an empty hide rule structure.- Returns:
- an empty hide rule structure
-
createIncludeScript
public static IncludeScript createIncludeScript()
Creates an empty include script structure.- Returns:
- an empty include script structure
-
createIncludeLibrary
public static IncludedLibrary createIncludeLibrary()
Creates an empty include library structure.- Returns:
- an empty include library structure
-
createIncludedCssStyleSheet
public static IncludedCssStyleSheet createIncludedCssStyleSheet()
Create an empty include css style sheet ststructure.- Returns:
- an empty include css style sheet structure.
-
createParamBinding
public static ParamBinding createParamBinding()
Creates an empty parameter binding structure.- Returns:
- an empty parameter binding structure
-
createPropertyMask
public static PropertyMask createPropertyMask()
Creates an empty property mask structure.- Returns:
- an empty property mask structure
-
createResultSetColumn
public static ResultSetColumn createResultSetColumn()
Creates an empty result set column structure.- Returns:
- an empty result set column structure
-
createOdaResultSetColumn
public static OdaResultSetColumn createOdaResultSetColumn()
Creates an empty oda result set column structure.- Returns:
- an empty result set column structure
-
createSearchKey
public static SearchKey createSearchKey()
Creates an empty search key structure.- Returns:
- an empty search key structure
-
createSelectionChoice
public static SelectionChoice createSelectionChoice()
Creates an empty selection choice structure.- Returns:
- an empty selection choice structure
-
createSortKey
public static SortKey createSortKey()
Creates an empty sort key structure.- Returns:
- an empty sort key structure
-
createColumnHint
public static ColumnHint createColumnHint()
Creates an empty column hint structure.- Returns:
- an empty column hint structure
-
createHighlightRule
public static HighlightRule createHighlightRule()
Creates an empty highlight rule structure.- Returns:
- an empty highlight rule structure
-
createMapRule
public static MapRule createMapRule()
Creates an empty map rule structure.- Returns:
- an empty map rule structure
-
createExtendedProperty
public static ExtendedProperty createExtendedProperty()
Creates an empty extended property structure.- Returns:
- an empty extended property structure
-
createJoinCondition
public static JoinCondition createJoinCondition()
Creates an empty join condition structure.- Returns:
- an empty join condition structure
-
createScriptLib
public static ScriptLib createScriptLib()
Creates an empty join condition structure.- Returns:
- an empty join condition structure
-
createOdaDesignerState
public static OdaDesignerState createOdaDesignerState()
Creates an empty oda designer state.- Returns:
- an empty oda designer state.
-
createEmbeddedImage
@Deprecated public static EmbeddedImage createEmbeddedImage(EmbeddedImageHandle baseImage)
Creates an embedded image from another library embedded image.- Parameters:
baseImage-- Returns:
- the created embedded image
-
newEmbeddedImageFrom
public static EmbeddedImage newEmbeddedImageFrom(EmbeddedImageHandle baseImage, java.lang.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
public static ComputedColumn newComputedColumn(DesignElementHandle element, java.lang.String newName)
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:
java.lang.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
public static TOC createTOC()
Create TOC structure.- Returns:
- toc object
-
createTOC
public static TOC createTOC(java.lang.String expression)
Create TOC structure with expression value.- Parameters:
expression- expression value- Returns:
- toc object
-
createCubeJoinCondition
public static DimensionCondition createCubeJoinCondition()
Creates an empty cube join condition structure.- Returns:
- an empty cube join condition structure.
-
createDimensionJoinCondition
public static DimensionJoinCondition createDimensionJoinCondition()
Creates an empty dimension join condition structure.- Returns:
- an empty dimension join condition structure.
-
createRule
public static Rule createRule()
Creates a Rule structure.- Returns:
- a rule structure
-
createLevelAttribute
public static LevelAttribute createLevelAttribute()
Creates an attribute for TabularLevel.- Returns:
- a level attribute
-
createOdaLevelAttribute
public static OdaLevelAttribute createOdaLevelAttribute()
Creates an attribute for OdaLevel.- Returns:
- a level attribute
-
createAggregationArgument
public static AggregationArgument createAggregationArgument()
Creates an aggregation argument for computed column.- Returns:
- an aggregation argument
-
createSortHint
public static SortHint createSortHint()
Creates a new sort hint.- Returns:
- a sort hint.
-
createTimeInterval
public static TimeInterval createTimeInterval()
Creates a new time interval.- Returns:
- a time interval.
-
newFormatValue
public static FormatValue newFormatValue()
Creates a new format value structure.- Returns:
- the format value created.
-
createCalculationArgument
public static CalculationArgument createCalculationArgument()
Creates a new calculation argument structure.- Returns:
- the calculation argument created
-
-