Class MetaTreeHelper

Represents the helper class for meta tree node objects.

Inheritance

System.Object

MetaTreeHelper

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.Olap.Data

Assembly: Syncfusion.Olap.Base.dll

Syntax

public class MetaTreeHelper

Constructors

MetaTreeHelper()

Declaration

public MetaTreeHelper()

Methods

FillMetaTreeNode(MetaTreeNode, Hierarchy)

Fills the meta tree node with hierarchy.

Declaration

public static void FillMetaTreeNode(MetaTreeNode mtNodeHierarchy, Hierarchy hierarchy)

Parameters

Type	Name	Description
MetaTreeNode	mtNodeHierarchy	The hierarchy meta tree node.
Hierarchy	hierarchy	The hierarchy object.

FillMetaTreeNode(MetaTreeNode, KpiCollection, Boolean, Boolean)

Fills the meta tree node with collection of KPIs.

Declaration

public static void FillMetaTreeNode(MetaTreeNode mtNodeCube, KpiCollection kpiCollection, bool isGroupVisible, bool isOverrideCurrentNode)

Parameters

Type	Name	Description
MetaTreeNode	mtNodeCube	The meta tree node for cube.
KpiCollection	kpiCollection	The collection of KPIs.
System.Boolean	isGroupVisible	Indicates whether the group is visible.
System.Boolean	isOverrideCurrentNode	Indicates whether to override the current node.

FillMetaTreeNode(MetaTreeNode, Level, Boolean, Boolean)

Fills the meta tree node with level.

Declaration

public static void FillMetaTreeNode(MetaTreeNode metaTreeLevel, Level levelObj, bool overrideOnDemandLoad, bool includeChildMembers)

Parameters

Type	Name	Description
MetaTreeNode	metaTreeLevel	The meta tree level.
Level	levelObj	The level obj.
System.Boolean	overrideOnDemandLoad	Indicates whether to load the member on demand.
System.Boolean	includeChildMembers	Indicates whether to include child members.

FillMetaTreeNode(MetaTreeNode, MeasureCollection, Boolean, Boolean)

Fills the meta tree node without ordering collection of measures.

Declaration

public static void FillMetaTreeNode(MetaTreeNode mtNodeCube, MeasureCollection measureCollection, bool isGroupVisible, bool isOverrideCurrentNode)

Parameters

Type	Name	Description
MetaTreeNode	mtNodeCube	The meta tree node for cube.
MeasureCollection	measureCollection	The collection of measure objects.
System.Boolean	isGroupVisible	Indicates whether the group is visible.
System.Boolean	isOverrideCurrentNode	Indicates whether to override the current node.

FillMetaTreeNode(MetaTreeNode, MeasureCollection, Boolean, Boolean, SortCubeMeasureOrder)

Fills the meta tree node with ordering collection of measures.

Declaration

public static void FillMetaTreeNode(MetaTreeNode mtNodeCube, MeasureCollection measureCollection, bool isGroupVisible, bool isOverrideCurrentNode, SortCubeMeasureOrder sortOrder)

Parameters

Type	Name	Description
MetaTreeNode	mtNodeCube	The meta tree node for cube.
MeasureCollection	measureCollection	The collection of measure objects.
System.Boolean	isGroupVisible	Indicates whether the group is visible.
System.Boolean	isOverrideCurrentNode	Indicates whether to override the current node.
SortCubeMeasureOrder	sortOrder	The sorting order.

FillMetaTreeNode(MetaTreeNode, MeasureCollection, Boolean, Boolean, SortCubeMeasureOrder, Dictionary<String, String>)

Fills the meta tree node with measure group.

Declaration

public static void FillMetaTreeNode(MetaTreeNode mtNodeCube, MeasureCollection measureCollection, bool isGroupVisible, bool isOverrideCurrentNode, SortCubeMeasureOrder sortOrder, Dictionary<string, string> groupCaptions)

Parameters

Type	Name	Description
MetaTreeNode	mtNodeCube	The meta tree node for cube.
MeasureCollection	measureCollection	The collection of measure objects.
System.Boolean	isGroupVisible	Indicates whether the group is visible.
System.Boolean	isOverrideCurrentNode	Indicates whether to override the current node.
SortCubeMeasureOrder	sortOrder	The sorting order.
System.Collections.Generic.Dictionary<System.String, System.String>	groupCaptions	The caption of measure groups.

FillMetaTreeNode(MetaTreeNode, Member, Boolean)

Fills the meta tree node with member.

Declaration

public static void FillMetaTreeNode(MetaTreeNode metaTreeMember, Member memberObj, bool overrideOnDemandLoad)

Parameters

Type	Name	Description
MetaTreeNode	metaTreeMember	The meta tree member.
Member	memberObj	The member object.
System.Boolean	overrideOnDemandLoad	Indicates whether to load the member on demand.

FillMetaTreeNode(MetaTreeNode, Member, Boolean, Boolean)

Fills the meta tree node with or without child members.

Declaration

public static void FillMetaTreeNode(MetaTreeNode metaTreeMember, Member memberObj, bool overrideOnDemandLoad, bool includeChildMembers)

Parameters

Type	Name	Description
MetaTreeNode	metaTreeMember	The meta tree member.
Member	memberObj	The member object.
System.Boolean	overrideOnDemandLoad	Indicates whether to load the member on demand.
System.Boolean	includeChildMembers	Indicates whether to include child members.

FillMetaTreeNode(MetaTreeNode, Member, Boolean, Boolean, Int32)

Fills the meta tree node with or without child members by specifying maximum level.

Declaration

public static void FillMetaTreeNode(MetaTreeNode metaTreeMember, Member memberObj, bool overrideOnDemandLoad, bool includeChildMembers, int maxLevel)

Parameters

Type	Name	Description
MetaTreeNode	metaTreeMember	The meta tree member.
Member	memberObj	The member object.
System.Boolean	overrideOnDemandLoad	Indicates whether to load the member on demand.
System.Boolean	includeChildMembers	Indicates whether to include child members.
System.Int32	maxLevel	The maximum level.

FillMetaTreeNode(MetaTreeNode, Items, Boolean)

Fills the meta tree node with calculated members.

Declaration

public static void FillMetaTreeNode(MetaTreeNode mtNodeCube, Items calculatedMembers, bool isOverrideCurrentNode)

Parameters

Type	Name	Description
MetaTreeNode	mtNodeCube	The meta tree node for cube.
Items	calculatedMembers	The collection of calculated members.
System.Boolean	isOverrideCurrentNode	Indicates whether to override the current node.

FillMetaTreeNode(MetaTreeNode, Boolean, CubeSchema, List<String>)

Fills the meta tree node by hiding some measures and dimensions.

Declaration

public static void FillMetaTreeNode(MetaTreeNode mtNodeCube, bool includeMembers, CubeSchema cubeSchema, List<string> removedElements)

Parameters

Type	Name	Description
MetaTreeNode	mtNodeCube	The meta tree node for cube.
System.Boolean	includeMembers	Indicates whether to include the members.
CubeSchema	cubeSchema	The cube schema.
System.Collections.Generic.List<System.String>	removedElements	The elements that are removed.

FillMetaTreeNode(MetaTreeNode, Boolean, Dimension)

Fills the meta tree node with dimension.

Declaration

public static void FillMetaTreeNode(MetaTreeNode mtNodeDimension, bool includeMembers, Dimension dimensionObj)

Parameters

Type	Name	Description
MetaTreeNode	mtNodeDimension	The dimension meta tree node.
System.Boolean	includeMembers	Indicates whether to include the members.
Dimension	dimensionObj	The dimension object.

FillMetaTreeNode(MetaTreeNode, Boolean, Dimension, NamedSetCollection)

Fills the meta tree node with named set.

Declaration

public static void FillMetaTreeNode(MetaTreeNode mtNodeDimension, bool includeMembers, Dimension dimensionObj, NamedSetCollection namedSetCollection)

Parameters

Type	Name	Description
MetaTreeNode	mtNodeDimension	The dimension meta tree node.
System.Boolean	includeMembers	Indicates whether to include the members.
Dimension	dimensionObj	The dimension object.
NamedSetCollection	namedSetCollection	The collection of named set.

FillMetaTreeNode(MetaTreeNode, Boolean, DimensionCollection)

Fills the meta tree node with dimension.

Declaration

public static void FillMetaTreeNode(MetaTreeNode mtNodeCube, bool includeMembers, DimensionCollection dimensionCollection)

Parameters

Type	Name	Description
MetaTreeNode	mtNodeCube	The meta tree node for cube.
System.Boolean	includeMembers	Indicates whether to include members.
DimensionCollection	dimensionCollection	The collection of dimension objects.

FillMetaTreeNode(MetaTreeNode, Boolean, DimensionCollection, DimensionCollection, NamedSetCollection)

Fills the meta tree node without excluded dimensions and with the collection of named set objects.

Declaration

public static void FillMetaTreeNode(MetaTreeNode mtNodeCube, bool includeMembers, DimensionCollection dimensionCollection, DimensionCollection removedDimensionCollection, NamedSetCollection namedSetCollection)

Parameters

Type	Name	Description
MetaTreeNode	mtNodeCube	The meta tree node for cube.
System.Boolean	includeMembers	Indicates whether to include the members.
DimensionCollection	dimensionCollection	The collection of dimension objects.
DimensionCollection	removedDimensionCollection	The collection of excluded dimension objects.
NamedSetCollection	namedSetCollection	The collection of named set objects.

FillMetaTreeNode(MetaTreeNode, Boolean, DimensionCollection, NamedSetCollection)

Fills the meta tree node with the collection of dimension and named set objects.

Declaration

public static void FillMetaTreeNode(MetaTreeNode mtNodeCube, bool includeMembers, DimensionCollection dimensionCollection, NamedSetCollection namedSetCollection)

Parameters

Type	Name	Description
MetaTreeNode	mtNodeCube	The meta tree node for cube.
System.Boolean	includeMembers	Indicates whether to include the members.
DimensionCollection	dimensionCollection	The collection of dimension objects.
NamedSetCollection	namedSetCollection	The collection of named set objects.

FillMetaTreeNode(MetaTreeNode, Boolean, Items)

Fills the meta tree node with virtual KPI group.

Declaration

public static void FillMetaTreeNode(MetaTreeNode mtNodeCube, bool isOverrideCurrentNode, Items virtualKpiElements)

Parameters

Type	Name	Description
MetaTreeNode	mtNodeCube	The meta tree node for cube.
System.Boolean	isOverrideCurrentNode	Indicates whether to override the current node.
Items	virtualKpiElements	The virtual KPI members.

FillMetaTreeNode(MetaTreeNode, Object)

Fills the meta tree node with specified object.

Declaration

public static void FillMetaTreeNode(MetaTreeNode mtNode, object element)

Parameters

Type	Name	Description
MetaTreeNode	mtNode	The MetaTree node.
System.Object	element	The element.

FillMetaTreeNode(KpiElements, MetaTreeNode, KpiCollection, Boolean)

Fills the meta tree node with KPI.

Declaration

public static void FillMetaTreeNode(KpiElements kpiElements, MetaTreeNode mtNodeCube, KpiCollection kpiCollection, bool isOverrideCurrentNode)

Parameters

Type	Name	Description
KpiElements	kpiElements	The KPI elements.
MetaTreeNode	mtNodeCube	The meta tree node for cube.
KpiCollection	kpiCollection	The collection of KPIs.
System.Boolean	isOverrideCurrentNode	Indicates whether to override the current node.

FillMetaTreeNode(MeasureElements, MetaTreeNode, MeasureCollection, Boolean, Boolean)

Fills the meta tree node with measure.

Declaration

public static void FillMetaTreeNode(MeasureElements measureElements, MetaTreeNode mtNodeCube, MeasureCollection measureCollection, bool isGroupVisible, bool isOverrideCurrentNode)

Parameters

Type	Name	Description
MeasureElements	measureElements	The measure elements.
MetaTreeNode	mtNodeCube	The meta tree node for cube.
MeasureCollection	measureCollection	The collection of measure objects.
System.Boolean	isGroupVisible	Indicates whether the group is visible.
System.Boolean	isOverrideCurrentNode	Indicates whether to override the current node.

FillMetaTreeNode(VirtualKpiElement, MetaTreeNode, Items, Boolean)

Fills the meta tree node with virtual KPI.

Declaration

public static void FillMetaTreeNode(VirtualKpiElement virtualKpiElement, MetaTreeNode metaTreeNodekpis, Items items, bool isOverideNode)

Parameters

Type	Name	Description
VirtualKpiElement	virtualKpiElement	The virtual KPI element.
MetaTreeNode	metaTreeNodekpis	The meta tree node for cube.
Items	items	The items collection.
System.Boolean	isOverideNode	Indicates whether to override the current node.

FillSelectedNodeCollection(MetaTreeNodeCollection, MetaTreeNode)

Fills the selected node collection.

Declaration

public static void FillSelectedNodeCollection(MetaTreeNodeCollection mtNodeCollection, MetaTreeNode mtNode)

Parameters

Type	Name	Description
MetaTreeNodeCollection	mtNodeCollection	The meta tree node collection.
MetaTreeNode	mtNode	The meta tree node.

FillSelectedNodeCollectionVersion3(MetaTreeNodeCollection, MetaTreeNode)

Fills the selected node collection version3.

Declaration

public static void FillSelectedNodeCollectionVersion3(MetaTreeNodeCollection mtNodeCollection, MetaTreeNode mtNode)

Parameters

Type	Name	Description
MetaTreeNodeCollection	mtNodeCollection	The meta tree node collection.
MetaTreeNode	mtNode	The meta tree node.

ForceFillChildNodes(MetaTreeNode)

Forces to the fill the child nodes.

Declaration

public static void ForceFillChildNodes(MetaTreeNode mtn)

Parameters

Type	Name	Description
MetaTreeNode	mtn	The meta tree node.

GetLevelOfKPI(String)

Gets the level of the KPI.

Declaration

public static int GetLevelOfKPI(string displayFolderName)

Parameters

Type	Name	Description
System.String	displayFolderName	The display name of the folder.

Returns

Type
System.Int32

GetVirtualKpiNode(VirtualKpiElement, Items)

Gets the virtual KPI node.

Declaration

public static MetaTreeNode GetVirtualKpiNode(VirtualKpiElement virtualKpiElement, Items items)

Parameters

Type	Name	Description
VirtualKpiElement	virtualKpiElement	The virtual KPI element.
Items	items	The items collection.

Returns

Type	Description
MetaTreeNode	The virtual KPI node.