Interface IDataProvider

Multidimensional data provider interface. An interface that must be implemented in OLAP data provider.

Namespace: Syncfusion.Olap.DataProvider

Assembly: Syncfusion.Olap.Base.dll

Syntax

public interface IDataProvider

Properties

CatalogName

Gets the name of the catalog.

Declaration

string CatalogName { get; }

Property Value

Type	Description
System.String	The name of the catalog.

ConnectionString

Gets/sets the connection string for the data adapter;

Declaration

string ConnectionString { get; set; }

Property Value

Type	Description
System.String

CurrentCellSet

Gets the current cell set.

Declaration

CellSet CurrentCellSet { get; }

Property Value

Type	Description
CellSet	The current cell set.

GetAllCubes

Gets the get all cubes.

Declaration

CubeInfoCollection GetAllCubes { get; }

Property Value

Type	Description
CubeInfoCollection	The get all cubes.

GetCubes

Gets the get cubes.

Declaration

CubeInfoCollection GetCubes { get; }

Property Value

Type	Description
CubeInfoCollection	The get cubes.

ProviderName

Gets or sets the name of the provider.

Declaration

Providers ProviderName { get; set; }

Property Value

Type	Description
Providers	The name of the provider.

Methods

CloseConnection()

Closes the connection.

Declaration

void CloseConnection()

Execute(String, OlapReport)

Executes the specified command text.

Declaration

object Execute(string commandText, OlapReport olapReport)

Parameters

Type	Name	Description
System.String	commandText	The command text.
OlapReport	olapReport	The OLAP report.

Returns

Type	Description
System.Object

ExecuteCellSet(String, Boolean, Boolean, OlapReport)

Executes the Command text and returns a cell set

Declaration

CellSet ExecuteCellSet(string commandText, bool IsGrandTotalOn, bool isQuery, OlapReport currentReport)

Parameters

Type	Name	Description
System.String	commandText	command text.
System.Boolean	IsGrandTotalOn	if set to true [is grand total on].
System.Boolean	isQuery	if set to true [is query].
OlapReport	currentReport	The current report.

Returns

Type	Description
CellSet	The CellSet

ExecuteCount(String)

Executes the count.

Declaration

int[] ExecuteCount(string mdxQuery)

Parameters

Type	Name	Description
System.String	mdxQuery	The MDX query.

Returns

Type	Description
System.Int32[]	Row and Column count result as an integer array.

ExecuteDrillThroughQuery(String)

Executes the DrillThroughQuery

Declaration

DataTable ExecuteDrillThroughQuery(string mdxQuery)

Parameters

Type	Name	Description
System.String	mdxQuery	The MDX query.

Returns

Type	Description
System.Data.DataTable

ExecuteMemberCount(String)

Executes the count.

Declaration

int ExecuteMemberCount(string mdxQuery)

Parameters

Type	Name	Description
System.String	mdxQuery	The MDX query.

Returns

Type	Description
System.Int32	Member count result as an integer.

GetAdomdCellSet()

Gets adomd cellset.

Declaration

CellSet GetAdomdCellSet()

Returns

Type	Description
Microsoft.AnalysisServices.AdomdClient.CellSet	The adomd cellset.

GetAllMemberUniqueName(String, String)

Gets the all member unique name.

Declaration

string GetAllMemberUniqueName(string cubeName, string hierarchyUniqueName)

Parameters

Type	Name	Description
System.String	cubeName	The name of the cube.
System.String	hierarchyUniqueName	The name of the hierarchy unique.

Returns

Type	Description
System.String	all member unique name of type string

GetCell(CellSet, Int32[])

Gets the cell based on the parameter index passed.

Declaration

Cell GetCell(CellSet cellSet, params int[] indexes)

Parameters

Type	Name	Description
CellSet	cellSet	The cell set
System.Int32[]	indexes	array of indexes

Returns

Type	Description
Cell	returns a Cell

GetChildMembers(Member, Boolean)

Gets the collection of child members.

Declaration

MemberCollection GetChildMembers(Member member, bool IsGrandTotalOn)

Parameters

Type	Name	Description
Member	member	The member.
System.Boolean	IsGrandTotalOn	Indicates whether the grand total is enabled.

Returns

Type	Description
MemberCollection	The collection of child members.

GetChildMembers(String, String, Boolean)

Gets the child members.

Declaration

MemberCollection GetChildMembers(string memberUniqueName, string cubeName, bool IsGrandTotalOn)

Parameters

Type	Name	Description
System.String	memberUniqueName	Unique name of the member.
System.String	cubeName	The name of the cube.
System.Boolean	IsGrandTotalOn	if set to true [is grand total on].

Returns

Type	Description
MemberCollection	Member Collection

GetChildrenByMDX(String)

Declaration

MemberCollection GetChildrenByMDX(string commandText)

Parameters

Type	Name	Description
System.String	commandText

Returns

Type	Description
MemberCollection

GetCubeSchema(String)

Gets the cube schema.

Declaration

CubeSchema GetCubeSchema(string cubeName)

Parameters

Type	Name	Description
System.String	cubeName	The name of the cube.

Returns

Type	Description
CubeSchema	returns a CubeSchema

GetLevelMembers(Level)

Gets the level members.

Declaration

MemberCollection GetLevelMembers(Level level)

Parameters

Type	Name	Description
Level	level	The level.

Returns

Type	Description
MemberCollection	returns a MemberCollection object

GetLevelMembers(String, String)

Gets the level members.

Declaration

MemberCollection GetLevelMembers(string levelUniqueName, string cubeName)

Parameters

Type	Name	Description
System.String	levelUniqueName	Unique name of a level.
System.String	cubeName	The name of the cube

Returns

Type	Description
MemberCollection	returns a MemberCollection object

GetMeasureGroupDimensions(String, String)

Gets a list of dimension names from the specified cube name and the from the specified measure group name.

Declaration

List<string> GetMeasureGroupDimensions(string cubeName, string measureGroupName)

Parameters

Type	Name	Description
System.String	cubeName	The current cube name.
System.String	measureGroupName	The measure group name.

Returns

Type	Description
System.Collections.Generic.List<System.String>	A list of dimension names.

GetMeasureGroups(String)

Gets a list measure group names from the cube.

Declaration

List<object> GetMeasureGroups(string cubeName)

Parameters

Type	Name	Description
System.String	cubeName	The current cube name.

Returns

Type	Description
System.Collections.Generic.List<System.Object>	A list of measure group names.

GetMeasuresDimensionUniqueName(String)

Gets the measures dimension unique name.

Declaration

string GetMeasuresDimensionUniqueName(string cubeName)

Parameters

Type	Name	Description
System.String	cubeName	The name of the cube.

Returns

Type	Description
System.String	measures dimension unique name of type string

GetParentMember(Member)

Gets the parent member.

Declaration

Member GetParentMember(Member member)

Parameters

Type	Name	Description
Member	member	The member

Returns

Type	Description
Member	returns a parent Member of the current member

HasValidCells()

Determines whether [has valid cells].

Declaration

bool HasValidCells()

Returns

Type	Description
System.Boolean	true if [has valid cells]; otherwise, false.

ValidateConnectionString()

Validates the connection string.

Declaration

bool ValidateConnectionString()

Returns

Type	Description
System.Boolean	true if connection string has proper syntax