Class DimensionConditionHandle
java.lang.Object
org.eclipse.birt.report.model.api.ElementDetailHandle
org.eclipse.birt.report.model.api.ValueHandle
org.eclipse.birt.report.model.api.StructureHandle
org.eclipse.birt.report.model.api.DimensionConditionHandle
Represents the handle of the cube-dimension/hierarchy join condition.
- Primary Keys
- Primary keys define a list of primary key to do the join actions between cube and hierarchy in dimension. Each one in the list must be one of the data set column in data set defined in cube.
- Hierarchy
- Hierarchy refers a hierarchy element in one of the dimension in the cube.
-
Field Summary
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle
structContext
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
elementHandle
-
Constructor Summary
ConstructorsConstructorDescriptionDimensionConditionHandle
(SimpleValueHandle valueHandle, int index) Constructs the handle of the cube join condition. -
Method Summary
Modifier and TypeMethodDescriptionaddJoinCondition
(DimensionJoinCondition joinCondition) Gets the dimension join condition handle.Gets the referred hierarchy handle of this condition.Gets the referred hierarchy name of this condition.Gets the member handle to deal with all theDimensionJoinCondition
.void
removeJoinCondition
(int index) Remove the join condition in the specified position.void
removeJoinCondition
(DimensionJoinCondition joinCondition) Removes join condition from this dimension condition.void
setHierarchy
(String hierarchyName) Sets the referred hierarchy by the name.void
setHierarchy
(HierarchyHandle hierarchyHandle) Sets the referred hierarchy by the handle.Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle
drop, getContext, getDefn, getExpressionProperty, getExternalizedValue, getExternalizedValue, getIntProperty, getMember, getProperty, getPropertyDefn, getStringProperty, getStructure, isDesignTime, isLocal, iterator, setDesignTime, setExpressionProperty, setProperty, setPropertySilently
Methods inherited from class org.eclipse.birt.report.model.api.ValueHandle
getReference
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
getDesign, getElement, getElementHandle, getModule
-
Constructor Details
-
DimensionConditionHandle
Constructs the handle of the cube join condition.- Parameters:
valueHandle
- the value handle for the cube join condition list of one propertyindex
- the position of this join condition in the list
-
-
Method Details
-
getJoinConditions
Gets the member handle to deal with all theDimensionJoinCondition
.- Returns:
- the member handle for all the DimensionJoinCondition
-
addJoinCondition
public DimensionJoinConditionHandle addJoinCondition(DimensionJoinCondition joinCondition) throws SemanticException Gets the dimension join condition handle.- Parameters:
joinCondition
- the join condition.- Returns:
- the dimension join condition handle.
- Throws:
SemanticException
-
removeJoinCondition
Removes join condition from this dimension condition.- Parameters:
joinCondition
- the join condition to remove- Throws:
SemanticException
-
removeJoinCondition
Remove the join condition in the specified position.- Parameters:
index
- the position where the join condition resides- Throws:
SemanticException
-
getHierarchy
Gets the referred hierarchy handle of this condition.- Returns:
- hierarchy handle of this condition if found, otherwise null
-
getHierarchyName
Gets the referred hierarchy name of this condition.- Returns:
- hierarchy name of this condition if set, otherwise null
-
setHierarchy
Sets the referred hierarchy by the name.- Parameters:
hierarchyName
- the hierarchy name to set- Throws:
SemanticException
-
setHierarchy
Sets the referred hierarchy by the handle.- Parameters:
hierarchyHandle
- the hierarchy handle to set- Throws:
SemanticException
-