Class CubeSchema

The CubeSchema class represents the meta-data of the cube. It contains information about dimensions and measures in the cube.

Inheritance

System.Object

CubeSchema

Implements

System.IDisposable

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 CubeSchema : IDisposable

Remarks

The CubeSchema is created in GetCubeSchema method of AdomdProvider, whenever a successful connection is made. Extracts all the informations according to the current connection state. A CubeSchema is associated only with AdomdProvider object.

Constructors

CubeSchema(IDataProvider)

Initializes a new instance of the CubeSchema class.

Declaration

public CubeSchema(IDataProvider dataProvider)

Parameters

Type	Name	Description
IDataProvider	dataProvider	The data provider.

Properties

CubeInfo

Gets or sets the cube information.

Declaration

public CubeInfo CubeInfo { get; set; }

Property Value

Type	Description
CubeInfo	A CubeInfo object represents multi-dimensional cube information.

DataProvider

Gets or sets the data provider.

Declaration

public IDataProvider DataProvider { get; set; }

Property Value

Type	Description
IDataProvider	The data provider used to retrieve the data schema.

Dimensions

Gets or sets the collection of dimensions.

Declaration

public DimensionCollection Dimensions { get; set; }

Property Value

Type	Description
DimensionCollection	A collection of dimension objects.

Kpis

Gets or sets the collection of KPIs.

Declaration

public KpiCollection Kpis { get; set; }

Property Value

Type	Description
KpiCollection	A collection of KPI objects.

Measures

Gets or sets the collection of measures.

Declaration

public MeasureCollection Measures { get; set; }

Property Value

Type	Description
MeasureCollection	A collection of measure objects.

NamedSets

Gets or sets the collection of named sets.

Declaration

public NamedSetCollection NamedSets { get; set; }

Property Value

Type	Description
NamedSetCollection	A collection of named set objects.

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

GetDefaultMeasure()

Gets the default measure.

Declaration

public Member GetDefaultMeasure()

Returns

Type	Description
Member	The default Measure Member of the cube.

GetDimensionByUniqueName(String)

Gets the dimension by its unique name.

Declaration

public Dimension GetDimensionByUniqueName(string uniqueName)

Parameters

Type	Name	Description
System.String	uniqueName	The unique name of dimension.

Returns

Type	Description
Dimension	The dimension object.

GetHierarchyByUniqueName(String)

Gets the hierarchy by its unique name.

Declaration

public Hierarchy GetHierarchyByUniqueName(string uniqueName)

Parameters

Type	Name	Description
System.String	uniqueName	The unique name of hierarchy.

Returns

Type	Description
Hierarchy	The hierarchy object.

GetLevelByUniqueName(String)

Gets the level by its unique name.

Declaration

public Level GetLevelByUniqueName(string uniqueName)

Parameters

Type	Name	Description
System.String	uniqueName	The unique name of level.

Returns

Type	Description
Level	The level object.

GetMeasure(String)

Gets the measure by passing its unique name.

Declaration

public Member GetMeasure(string uniquename)

Parameters

Type	Name	Description
System.String	uniquename	Unique name of the Measure.

Returns

Type	Description
Member	Member

GetMemberByUniqueName(List<String>)

Gets the name of the member by unique.

Declaration

public Member GetMemberByUniqueName(List<string> uniqueName)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.String>	uniqueName	The name of the unique.

Returns

Type	Description
Member	A member object of type Member.

GetMemberByUniqueName(String, Boolean)

Gets the Member by its unique name.

Declaration

public Member GetMemberByUniqueName(string uniqueName, bool isLoadedMembersOnly)

Parameters

Type	Name	Description
System.String	uniqueName	Member uniquename.
System.Boolean	isLoadedMembersOnly	if set to true [is loaded members only].

Returns

Type	Description
Member	The Member Object

GetMemberByUniqueNameForNonSSAS(List<String>)

Gets the member by unique name for non SSAS.

Declaration

public Member GetMemberByUniqueNameForNonSSAS(List<string> uniqueName)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.String>	uniqueName	The name of the unique.

Returns

Type	Description
Member	A member object of type Member.

GetNamedSetByUniqueName(String)

Gets the NamedSet by its unique name

Declaration

public NamedSet GetNamedSetByUniqueName(string uniqueName)

Parameters

Type	Name	Description
System.String	uniqueName	NamedSets Unique name.

Returns

Type	Description
NamedSet	The namedSet object

GetTimeDimension()

Gets the time dimension.

Declaration

public Dimension GetTimeDimension()

Returns

Type	Description
Dimension	The Time Dimension of the Current Cube

Implements

System.IDisposable