Class QueryBuilderEngineHelper

This helper class that is used for helping the query builder engine to populate items from other assemblies.

Inheritance

System.Object

QueryBuilderEngineHelper

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.MDXQueryBuilder

Assembly: Syncfusion.Olap.Base.dll

Syntax

public class QueryBuilderEngineHelper

Constructors

QueryBuilderEngineHelper()

Declaration

public QueryBuilderEngineHelper()

Methods

DrillUpDown(HierarchyElement, Member)

Drills up or down the hierarchy element based on the parent member.

Declaration

public static bool DrillUpDown(HierarchyElement hierarchyElement, Member drillDownParentMember)

Parameters

Type	Name	Description
HierarchyElement	hierarchyElement	The hierarchy element.
Member	drillDownParentMember	The drill down parent member.

Returns

Type	Description
System.Boolean	True if children are appended, or else false.

DrillUpDown(MemberElement, Member)

Drills down to its child members based on the specified member.

Declaration

public static bool DrillUpDown(MemberElement memberElement, Member drillDownParentMember)

Parameters

Type	Name	Description
MemberElement	memberElement	The member element.
Member	drillDownParentMember	The drill down parent member.

Returns

Type	Description
System.Boolean	True if drill up and down are done successfully, or else false.

Remarks

Internally it adds the child members to the element object, so that the query generator picks up the child member and generates the query.

FillMDXQuerySpecification(MDXQuerySpecification, MetaTreeNodeCollection, AxisPosition)

Updates the MDXQuerySpecification object with new elements based on the collection of meta tree nodes passed.

Declaration

public static void FillMDXQuerySpecification(MDXQuerySpecification mdxQuery, MetaTreeNodeCollection mtNodeCollection, AxisPosition axis)

Parameters

Type	Name	Description
MDXQuerySpecification	mdxQuery	The MDX query.
MetaTreeNodeCollection	mtNodeCollection	The collection of meta tree nodes.
AxisPosition	axis	The axis position

FindItemsFromMetaTreeNode(MetaTreeNode, Items)

Finds the element item from meta tree node.

Declaration

public static Item FindItemsFromMetaTreeNode(MetaTreeNode metaTreeNode, Items items)

Parameters

Type	Name	Description
MetaTreeNode	metaTreeNode	The meta tree node.
Items	items	The collection of items.

Returns

Type	Description
Item	The element item.

GetElementItemFromMetaTree(MetaTreeNode, AxisPosition)

Gets the element item from meta tree node.

Declaration

public static Item GetElementItemFromMetaTree(MetaTreeNode metaTreeNode, AxisPosition axis)

Parameters

Type	Name	Description
MetaTreeNode	metaTreeNode	The meta tree node.
AxisPosition	axis	The axis position.

Returns

Type	Description
Item	The element item from meta tree node.

GetElementItemsFromMetaTree(MetaTreeNodeCollection, AxisPosition)

Builds the element items from meta tree node.

Declaration

public static Items GetElementItemsFromMetaTree(MetaTreeNodeCollection mtNodeCollection, AxisPosition axis)

Parameters

Type	Name	Description
MetaTreeNodeCollection	mtNodeCollection	The collection of meta tree nodes.
AxisPosition	axis	The axis position

Returns

Type	Description
Items	The element items from meta tree node.

GetElementValue(MetaTreeNode, Boolean)

Generates the element based on selected and unselected nodes

Declaration

public static Element GetElementValue(MetaTreeNode metaTreeNode, bool includeSelectedElements)

Parameters

Type	Name	Description
MetaTreeNode	metaTreeNode	The meta tree node.
System.Boolean	includeSelectedElements	Indicates whether to include the selected nodes in elements collection.

Returns

Type
Element

GetReportMemberElements(MemberElement, MemberElementCollection)

Gets the collection of report member elements.

Declaration

public static MemberElementCollection GetReportMemberElements(MemberElement memElement, MemberElementCollection reportElementCollection)

Parameters

Type	Name	Description
MemberElement	memElement	The member element.
MemberElementCollection	reportElementCollection	The collection of report elements.

Returns

Type	Description
MemberElementCollection	The collection of report elements.

GetUniqueNames<T>(T)

Gets an auto-incremented version of the specified base name that does not exist already in the specified collection.

Declaration

public static List<string> GetUniqueNames<T>(T item)

Parameters

Type	Name	Description
T	item	The item.

Returns

Type	Description
System.Collections.Generic.List<System.String>	The collection of unique names.

Type Parameters

Name	Description
T	The type of item.

SetProviderName(Providers)

Sets the name of the provider.

Declaration

public static void SetProviderName(Providers providerName)

Parameters

Type	Name	Description
Providers	providerName	The name of the provider.

UpdateDrillDownItems(Items, Member)

Updates the drill down items based on the categorical or series items passed internally.

Declaration

public static bool UpdateDrillDownItems(Items items, Member member)

Parameters

Type	Name	Description
Items	items	The collection of items.
Member	member	The member.

Returns

Type	Description
System.Boolean	True if drill-down happens, or else false.

UpdateItemsFromMetaTree(MetaTreeNodeCollection, AxisPosition, Items)

Updates the items from meta tree node.

Declaration

public static void UpdateItemsFromMetaTree(MetaTreeNodeCollection mtNodeCollection, AxisPosition axis, Items items)

Parameters

Type	Name	Description
MetaTreeNodeCollection	mtNodeCollection	The collection of meta tree nodes.
AxisPosition	axis	The axis position.
Items	items	The collection of items.