Interface BI2Hierarchy

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, ELClassifier, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELRedefAble, ELType, ELUUIDAble, ELValueContainerAble, ELView, ELViewElement, ELViewGroupAble, MECommentAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface BI2Hierarchy
extends ADHistoryAble, MEStereotypeAble, MECommentAble, MENamespaceAsgnAble, ELView, MMLabelTextAttachmentAble

A BI2Hierarchy is a path in a BI2DimensionTree through which the data is collected in aggregated form.

See Also:

• BI2HierarchyHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BI2Hierarchy.VAttr

Method Summary

Modifier and Type	Method	Description
List<BI2CubeDimensionHierarchy>	getDimensionHierarchy()	List of all cube dimension hierarchy usages of this BI2Hierarchy.
String	getHierarchyLevelDisplayNames()	Returns the names of the hierarchy levels as a comma separated string including short names.
String	getHierarchyLevelNames()	Returns the names of the hierarchy levels as a comma separated string.
List<BI2Hierarchy>	getHierarchyWithSameCubeDimension()	All BI2Hierarchy which are referenced by the same BI2CubeDimension.
List<BI2Hierarchy>	getHierarchyWithSameCubeDimension(MMStereotype stereotype)	The method calls getHierarchyWithSameCubeDimension and filters its return values according to the given stereotype value.
BI2HierarchyLevel	getLowestLevel()	Returns the lowest BI2HierarchyLevel of this BI2Hierarchy.
BI2HierarchyLevel	getOwnedHierarchyLevelByDimensionLevel(BI2DimensionLevel refObj)	The BI2HierarchyLevel owned by this BI2Hierarchy which references the argument refObj.
List<BI2HierarchyLevel>	getOwnedLevel(K_CONTROL_OPTION... behaviourFlags)	List of levels of this BI2Hierarchy, representing an BI2DimensionLevel.
List<BI2DimensionPrecedence>	getPrecedences()	Get all precedences of the BI2DimensionTree which are part of this BI2Hierarchy.
List<BI2DimensionPrecedence>	getPrecedences(MMStereotype stereotype)	The method calls getPrecedences and filters its return values according to the given stereotype value.
boolean	hasAll()	Returns whether this BI2Hierarchy has an 'all' member.
void	maintainLevelSortOrder()	This maintaining method sorts the hierarchy levels in an appropriate order for precedences.
void	setAll(boolean value)	Set the value of Attribut HasAll.

Methods inherited from interface ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

Methods inherited from interface ADHistoryAble

getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory

Methods inherited from interface ADM2AttrModifyAble

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

Methods inherited from interface ELClassifier

getAssociation, getAssociation, getAssociationEndFirstTypedBySelf, getAssociationEndFirstTypedBySelf, getAssociationEndNavigableTypedBySelf, getAssociationEndNavigableTypedBySelf, getAssociationEndNavigableTypedBySelfOrGeneralTransitive, getAssociationEndNavigableTypedBySelfOrGeneralTransitive, getAssociationEndTypedBySelf, getAssociationEndTypedBySelf, getAssociationEndTypedBySelfOrGeneralTransitive, getAssociationEndTypedBySelfOrGeneralTransitive, getAssociationNavigableFrom, getAssociationNavigableFrom, getAssociationOfSelfOrGeneralTransitive, getAssociationOfSelfOrGeneralTransitive, getAssociationTypedBySelf, getAssociationTypedBySelf, getClassifierViewGroup, getEffectiveRedefinerOfAssocEnd, getEffectiveRedefinerOfAssocEnd, getEffectiveSubsetterOfAssocEnd, getEffectiveSubsetterOfAssocEnd, getGeneralDirect, getGeneralDirect, getGeneralGeneralizationSet, getGeneralGeneralizationSet, getGeneralization, getGeneralTransitive, getGeneralTransitive, getOwnedAndInheritedMember, getOwnedAndInheritedMember, getPropertyNavigableFrom, getPropertyNavigableFrom, getPropertyNavigableFromSelfOrGeneralTransitive, getPropertyNavigableFromSelfOrGeneralTransitive, getSelfAndGeneralTransitive, getSelfAndGeneralTransitive, getSelfAndSpecificTransitive, getSelfAndSpecificTransitive, getSelfAndSpecificTransitiveNotAbstract, getSelfAndSpecificTransitiveNotAbstract, getSpecialization, getSpecificDirect, getSpecificDirect, getSpecificGeneralization, getSpecificGeneralizationSet, getSpecificGeneralizationSet, getSpecificTransitive, getSpecificTransitive, getSpecificTransitiveNotAbstract, getSpecificTransitiveNotAbstract, getSpecificTransitiveNotAbstractRange, getSpecificTransitiveNotAbstractRange, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEndIntersectedByInverseAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEndIntersectedByInverseAssocEnd, getTypedCLStructureEntry, getTypedMaskField, getTypesOfEffectiveSubsetterOfAssocEnd, getTypesOfEffectiveSubsetterOfAssocEnd, getViewTransitive, getViewTransitive, isAbstract, isRoot, isSpecificTransitive, setAbstract

Methods inherited from interface ELContainerAble

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

Methods inherited from interface ELContAsgnAble

getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner

Methods inherited from interface ELDeleteAble

delete

Methods inherited from interface ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getNotificationElement, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface ELNamedElement

getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKind

Methods inherited from interface ELNamespaceAble

getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getItemDefinition, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImport

Methods inherited from interface ELNamespaceAsgnAble

getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility

Methods inherited from interface ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Methods inherited from interface ELPackageAble

getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackage

Methods inherited from interface ELRedefAble

getRedefined, getRedefining, isLeaf, isRedefined, isRedefining, setLeaf, setRedefined

Methods inherited from interface ELType

getRaisingAsException, getTypedElement, getTypedElementNotAssocEnd, getTypedElementNotAssocEnd, isTypeReuseable

Methods inherited from interface ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface ELView

hasDirectReferenceToClassifier, hasReferenceToClassifier, isReadOnly, setReadOnly

Methods inherited from interface ELViewElement

getConcreteExpression, getConcreteExpressionQuoted, getEnvironmentView, getExprFlowText, getExprInnoRefText, getExprText, getModifyViewExpressionFlow, getUsedFeature, modifyViewExpressionFlow, setConcreteExpression, setExprFlowText, setExprInnoRefText, setUsedFeature

Methods inherited from interface ELViewGroupAble

getFeatureNotUsedByEntry, getFeatureNotUsedByEntry, getFeatureUsedByEntry, getFeatureUsedByEntry, getGroupType, getOwnedViewEntry, getOwnedViewGroup, getViewGroupClassifier, getXSDElemType, setGroupType, setViewGroupClassifier, setXSDElemType

Methods inherited from interface MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface MEModelElement

buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getDataModel, getDataModelName, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor

Methods inherited from interface MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface MENamespaceAsgnAble

getSignatureMessage

Methods inherited from interface MEStereotypeAble

getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getMEClientDependency, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholder

Methods inherited from interface METermAble

getTerm, setTerm

Methods inherited from interface MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

Methods inherited from interface MMLabelAble

getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo

Methods inherited from interface MMStereotypeAble

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getExtendingStereotype, getExtendingStereotypeNames, getOwnedFormat, getOwnedStereotypePropertyValSpec, getOwnedStereotypeTSOptionValSpec, getOwnedSyncedElement, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, getStereotypeTSOption, getStereotypeTSOptionBoolValue, getStereotypeTSOptionInfo, getStereotypeTSOptionLongValue, getStereotypeTSOptionNameValue, getStereotypeTSOptionStringValue, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueList, getSyncedElement, getSyncedStereotypeAble, getSyncedStereotypeAble, isCloneAbleElement, modifyStereotypePropertyValuesByName, modifyStereotypeTSOptionValuesByName, setExtendingStereotype, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Methods inherited from interface MMTextAble

getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getText, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg

Method Details

hasAll

boolean hasAll()
        throws InoNetException,
SrvErrorException

Returns whether this BI2Hierarchy has an 'all' member.

Throws:

InoNetException

SrvErrorException

setAll

void setAll(boolean value)
     throws InoNetException,
SrvErrorException

Set the value of Attribut HasAll.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getHierarchyLevelNames

String getHierarchyLevelNames()
                       throws InoNetException,
SrvErrorException

Returns the names of the hierarchy levels as a comma separated string.

Throws:

InoNetException

SrvErrorException

getHierarchyLevelDisplayNames

String getHierarchyLevelDisplayNames()
                              throws InoNetException,
SrvErrorException

Returns the names of the hierarchy levels as a comma separated string including short names.

Throws:

InoNetException

SrvErrorException

getOwnedHierarchyLevelByDimensionLevel

BI2HierarchyLevel getOwnedHierarchyLevelByDimensionLevel(BI2DimensionLevel refObj)
                                                  throws InoNetException,
SrvErrorException

The BI2HierarchyLevel owned by this BI2Hierarchy which references the argument refObj.

Parameters:

refObj - A further instance of type BI2DimensionLevel which is used to control the behaviour of the method. (see description above)

Throws:

InoNetException

SrvErrorException

getHierarchyWithSameCubeDimension

List<BI2Hierarchy> getHierarchyWithSameCubeDimension()
                                              throws InoNetException,
SrvErrorException

All BI2Hierarchy which are referenced by the same BI2CubeDimension.

Throws:

InoNetException

SrvErrorException

getHierarchyWithSameCubeDimension

List<BI2Hierarchy> getHierarchyWithSameCubeDimension(MMStereotype stereotype)
                                              throws InoNetException,
SrvErrorException

The method calls getHierarchyWithSameCubeDimension and filters its return values according to the given stereotype value.

Parameters:

stereotype - The stereotype used to filter the result list

Throws:

InoNetException

SrvErrorException

getPrecedences

List<BI2DimensionPrecedence> getPrecedences()
                                     throws InoNetException,
SrvErrorException

Get all precedences of the BI2DimensionTree which are part of this BI2Hierarchy.

Throws:

InoNetException

SrvErrorException

getPrecedences

List<BI2DimensionPrecedence> getPrecedences(MMStereotype stereotype)
                                     throws InoNetException,
SrvErrorException

The method calls getPrecedences and filters its return values according to the given stereotype value.

Parameters:

stereotype - The stereotype used to filter the result list

Throws:

InoNetException

SrvErrorException

getLowestLevel

BI2HierarchyLevel getLowestLevel()
                          throws InoNetException,
SrvErrorException

Returns the lowest BI2HierarchyLevel of this BI2Hierarchy. The lowest means the level which is properly referencing the lowest BI2DimensionLevel.

Throws:

InoNetException

SrvErrorException

maintainLevelSortOrder

void maintainLevelSortOrder()
                     throws InoNetException,
SrvErrorException

This maintaining method sorts the hierarchy levels in an appropriate order for precedences. The lowest level will have the highest consecutive number.

Throws:

InoNetException

SrvErrorException

getDimensionHierarchy

List<BI2CubeDimensionHierarchy> getDimensionHierarchy()
                                               throws InoNetException,
SrvErrorException

List of all cube dimension hierarchy usages of this BI2Hierarchy.

Throws:

InoNetException

SrvErrorException

getOwnedLevel

List<BI2HierarchyLevel> getOwnedLevel(K_CONTROL_OPTION... behaviourFlags)
                               throws InoNetException,
SrvErrorException

List of levels of this BI2Hierarchy, representing an BI2DimensionLevel.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the list is sorted!