Class OlapDataManager

Represents the management of data.

Inheritance

System.Object

OlapDataManager

Implements

IOlapDataManager

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

Assembly: Syncfusion.Olap.Base.dll

Syntax

public class OlapDataManager : IOlapDataManager, IDisposable

Constructors

OlapDataManager()

Initializes a new instance of the OlapDataManager class.

Declaration

public OlapDataManager()

OlapDataManager(IDataProvider)

Initializes a new instance of the OlapDataManager class.

Declaration

public OlapDataManager(IDataProvider adomdDataProvider)

Parameters

Type	Name	Description
IDataProvider	adomdDataProvider	The ADOMD data provider.

OlapDataManager(String)

Initializes a new instance of the OlapDataManager class.

Declaration

public OlapDataManager(string connectionString)

Parameters

Type	Name	Description
System.String	connectionString	The connection string.

Properties

ActiveReport

Gets or sets the OlapReport when multiple OlapControls shares same OlapDataManager.

Declaration

public OlapReport ActiveReport { get; set; }

Property Value

Type
OlapReport

AllowMdxToOlapReportParse

Gets or Sets a value indicating whether to enable the MDX query while parsing the OLAP report.

Declaration

public bool AllowMdxToOlapReportParse { get; set; }

Property Value

Type
System.Boolean

CalculatedMembers

Gets or sets the calculated members/measures collection.

Declaration

public Items CalculatedMembers { get; set; }

Property Value

Type
Items

ConnectionString

Gets or sets the connection string.

Declaration

public string ConnectionString { get; set; }

Property Value

Type	Description
System.String	The connection string.

Culture

Gets or sets the culture.

Declaration

public CultureInfo Culture { get; set; }

Property Value

Type	Description
System.Globalization.CultureInfo	The culture.

CurrentCellSet

Gets the current cell set.

Declaration

public CellSet CurrentCellSet { get; }

Property Value

Type	Description
CellSet	The current cell set.

CurrentCubeName

Gets or sets the name of the current cube.

Declaration

public string CurrentCubeName { get; set; }

Property Value

Type	Description
System.String	The name of the current cube.

CurrentCubeSchema

Gets or sets the current cube schema.

Declaration

public CubeSchema CurrentCubeSchema { get; set; }

Property Value

Type	Description
CubeSchema	The current cube schema.

CurrentReport

Gets or sets the current report.

Declaration

public OlapReport CurrentReport { get; set; }

Property Value

Type	Description
OlapReport	The current report.

DataProvider

Gets or sets the data provider.

Declaration

public IDataProvider DataProvider { get; set; }

Property Value

Type	Description
IDataProvider	The data provider.

EnableExceptionHandling

Gets or sets whether to handle exceptions.

Declaration

public bool EnableExceptionHandling { get; set; }

Property Value

Type
System.Boolean

ForceWhereClauseForSlicing

Gets or sets a value indicating whether to generate the MDX query with only "Where" clause while slicing.

Declaration

public bool ForceWhereClauseForSlicing { get; set; }

Property Value

Type
System.Boolean

IsCurrentReportModified

Gets or sets a value indicating whether the current report is modified.

Declaration

public bool IsCurrentReportModified { get; set; }

Property Value

Type
System.Boolean

IsProcessing

Gets or sets a value indicating whether the OLAP data manager is processing.

Declaration

public bool IsProcessing { get; set; }

Property Value

Type
System.Boolean

ItemSource

Gets or sets the item source.

Declaration

public object ItemSource { get; set; }

Property Value

Type	Description
System.Object	The item source.

MdxQuery

Gets or sets the MDX query.

Declaration

public string MdxQuery { get; set; }

Property Value

Type	Description
System.String	The MDX query.

Name

Gets or sets the name of the OLAP data manager.

Declaration

public string Name { get; set; }

Property Value

Type
System.String

OverrideDefaultFormatStrings

Gets or sets a value indicating whether to override the default OLAP Cube's strings format.

Declaration

public bool OverrideDefaultFormatStrings { get; set; }

Property Value

Type
System.Boolean

PivotEngine

Gets or sets the pivot engine.

Declaration

public PivotEngine PivotEngine { get; set; }

Property Value

Type	Description
PivotEngine	The pivot engine.

Properties

Gets or sets the collection of properties.

Declaration

public PropertyCollection Properties { get; set; }

Property Value

Type	Description
PropertyCollection	The collection of properties.

QuerySpecification

Gets the query specification.

Declaration

[Obsolete("Use GetMDXQuerySpecification() method instead")]
public MDXQuerySpecification QuerySpecification { get; }

Property Value

Type	Description
MDXQuerySpecification	The query specification.

RelationalDataSortOrder

Gets or sets the sorting order of relational data.

Declaration

public SortType RelationalDataSortOrder { get; set; }

Property Value

Type	Description
SortType	The sorting order of relational data.

ReportPath

Gets the path of the current report.

Declaration

public string ReportPath { get; }

Property Value

Type
System.String

Reports

Gets or sets the collection of OLAP reports.

Declaration

public OlapReportCollection Reports { get; set; }

Property Value

Type	Description
OlapReportCollection	The collection of OLAP reports.

ShowLevelTypeAll

Gets or sets a value indicating whether to show the level type of 'All'.

Declaration

public bool ShowLevelTypeAll { get; set; }

Property Value

Type
System.Boolean

ShowLocalizedMemberProperties

Gets or sets a value indicating whether to display the localized member properties.

Declaration

public bool ShowLocalizedMemberProperties { get; set; }

Property Value

Type
System.Boolean

UseSharedDataManager

Gets or sets whether this instance can be shared among different OLAP controls. Default value is false.

Declaration

public bool UseSharedDataManager { get; set; }

Property Value

Type
System.Boolean

UseWhereClauseForSlicing

Gets or sets a value indicating whether to slice data using "Where" clause or "Select" clause.

Declaration

public bool UseWhereClauseForSlicing { get; set; }

Property Value

Type
System.Boolean

VirtualKpiElements

Gets or sets the virtual KPI collection.

Declaration

public Items VirtualKpiElements { get; set; }

Property Value

Type
Items

Methods

AddReport(OlapReport)

Adds the specified OLAP report.

Declaration

public void AddReport(OlapReport report)

Parameters

Type	Name	Description
OlapReport	report	The OLAP report to be added.

AddReport(String)

Adds the report with specified name.

Declaration

public void AddReport(string reportName)

Parameters

Type	Name	Description
System.String	reportName	The name of the report.

BuildDrillThroughQuery(PivotCellDescriptor, String)

Builds the drill through query.

Declaration

public string BuildDrillThroughQuery(PivotCellDescriptor cellDescriptor, string drillThroughHierarchies)

Parameters

Type	Name	Description
PivotCellDescriptor	cellDescriptor	The cell descriptor.
System.String	drillThroughHierarchies	The drill through hierarchies.

Returns

Type	Description
System.String	The drill through query.

CloneOlapDataManagerElements()

Clones the elements of OLAP data manager.

Declaration

public OlapDataManager CloneOlapDataManagerElements()

Returns

Type	Description
OlapDataManager	A OlapDataManager object.

CloseConnection()

Closes the connection.

Declaration

public void CloseConnection()

Dispose()

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

Declaration

public void Dispose()

Execute(String)

Executes the specified command text.

Declaration

public object Execute(string commandText)

Parameters

Type	Name	Description
System.String	commandText	The command text.

Returns

Type	Description
System.Object	Object contains the cell set information.

Execute(String, Boolean)

Executes the specified command text.

Declaration

public object Execute(string commandText, bool returnResult)

Parameters

Type	Name	Description
System.String	commandText	The command text.
System.Boolean	returnResult	if set to `true` [return result].

Returns

Type	Description
System.Object	Object contains the cell set information.

ExecuteCellSet()

Returns the cell set based on the MDX query.

Declaration

public virtual CellSet ExecuteCellSet()

Returns

Type	Description
CellSet	The cell set after running the MDX query or query specifications.

ExecuteCellSet(MDXQuerySpecification)

Executes the cell set.

Declaration

[Obsolete("Use ExecuteCellSet instead")]
public CellSet ExecuteCellSet(MDXQuerySpecification querySpecification)

Parameters

Type	Name	Description
MDXQuerySpecification	querySpecification	The query specification.

Returns

Type
CellSet

ExecuteCellSet(String)

Executes the cell set.

Declaration

public CellSet ExecuteCellSet(string commandText)

Parameters

Type	Name	Description
System.String	commandText	The command text.

Returns

Type	Description
CellSet	CellSet

ExecuteCellSet(String, Boolean)

Executes cell set.

Declaration

public CellSet ExecuteCellSet(string commandText, bool isGrandTotalOn)

Parameters

Type	Name	Description
System.String	commandText
System.Boolean	isGrandTotalOn

Returns

Type
CellSet

ExecuteCount()

Executes the count.

Declaration

public SerializableDictionary<string, int> ExecuteCount()

Returns

Type
SerializableDictionary<System.String, System.Int32>

ExecuteMemberCount(String, String)

Executes the count.

Declaration

public int ExecuteMemberCount(string uniqueName, string cubeName)

Parameters

Type	Name	Description
System.String	uniqueName
System.String	cubeName

Returns

Type
System.Int32

ExecuteOlapTable()

Generates a two dimensional representation of pivot engine that is created from the cell set based on the current report.

Declaration

public PivotEngine ExecuteOlapTable()

Returns

Type	Description
PivotEngine	The pivot engine i.e., a two dimensional representation of the cell set.

ExecuteOlapTable(CellSet)

Generates a two dimensional representation of pivot engine that is created from the cell set based on the cell set.

Declaration

public PivotEngine ExecuteOlapTable(CellSet cellSet)

Parameters

Type	Name	Description
CellSet	cellSet	The cell set.

Returns

Type	Description
PivotEngine	The pivot engine i.e., a two dimensional representation of the cell set.

ExecuteOlapTable(CellSet, GridLayout)

Generates a two dimensional representation of pivot engine that is created from the cell set based on the cell set and the grid layout.

Declaration

public PivotEngine ExecuteOlapTable(CellSet cellSet, GridLayout layout)

Parameters

Type	Name	Description
CellSet	cellSet	The cell set.
GridLayout	layout	The grid layout.

Returns

Type	Description
PivotEngine	The pivot engine i.e., a two dimensional representation of the cell set.

ExecuteOlapTable(GridLayout)

Generates a two dimensional representation of pivot engine that is created from the cell set based on the grid layout.

Declaration

public PivotEngine ExecuteOlapTable(GridLayout layout)

Parameters

Type	Name	Description
GridLayout	layout	The grid layout.

Returns

Type	Description
PivotEngine	The pivot engine i.e., a two dimensional representation of the cell set.

ExecuteOlapTable(String)

Generates a two dimensional representation of pivot engine that is created from the cell set based on the MDX query.

Declaration

public PivotEngine ExecuteOlapTable(string commandText)

Parameters

Type	Name	Description
System.String	commandText	The MDX query.

Returns

Type	Description
PivotEngine	The pivot engine i.e., a two dimensional representation of the cell set.

GetDrillDownMDXQuery(PivotCellDescriptor)

Get the drill down/up query for the cell descriptor passed

Declaration

public string GetDrillDownMDXQuery(PivotCellDescriptor cellDescriptor)

Parameters

Type	Name	Description
PivotCellDescriptor	cellDescriptor	Drill down member

Returns

Type	Description
System.String	The MDX Query after performing a drilldown operation.

GetDrillDownMDXQuery(PivotCellDescriptorType, Member)

Gets the drill down MDX query.

Declaration

public string GetDrillDownMDXQuery(PivotCellDescriptorType cellType, Member memberObj)

Parameters

Type	Name	Description
PivotCellDescriptorType	cellType	Type of the cell.
Member	memberObj	The member obj.

Returns

Type	Description
System.String	The MDX Query after performing a drill down operation.

GetExpandedRows(PivotCellDescriptor)

Returns the OLAP table with expanded rows only.

Declaration

public PivotEngine GetExpandedRows(PivotCellDescriptor cellDescriptor)

Parameters

Type	Name	Description
PivotCellDescriptor	cellDescriptor	Descriptor to get expanded rows.

Returns

Type	Description
PivotEngine	The pivot engine with expanded rows.

GetMDXQuery()

Gets the MDX query.

Declaration

public string GetMDXQuery()

Returns

Type	Description
System.String	String contains the MDX Query.

GetMemberProperties(PivotCellDescriptor)

Gets the member properties for header tool-tip.

Declaration

public static PivotEngine GetMemberProperties(PivotCellDescriptor expandCell)

Parameters

Type	Name	Description
PivotCellDescriptor	expandCell	The expanded cell.

Returns

Type	Description
PivotEngine	The pivot engine.

GetPositionsInfo(PivotCellDescriptor)

Gets the position information.

Declaration

public List<PositionInfo> GetPositionsInfo(PivotCellDescriptor cellDescriptor)

Parameters

Type	Name	Description
PivotCellDescriptor	cellDescriptor	The cell descriptor.

Returns

Type
System.Collections.Generic.List<PositionInfo>

GetReport(String)

Gets the OLAP report.

Declaration

public OlapReportCollection GetReport(string fileName)

Parameters

Type	Name	Description
System.String	fileName	The name of the file.

Returns

Type	Description
OlapReportCollection	The collection of OLAP reports.

GetReportAsStream()

Gets the OLAP report as stream.

Declaration

public Stream GetReportAsStream()

Returns

Type	Description
System.IO.Stream	The report as stream

GetRowAndColumnCount(MDXQuerySpecification)

Gets the row and column count.

Declaration

[Obsolete("This method is obsolete and will be removed in a future release.")]
public static int[] GetRowAndColumnCount(MDXQuerySpecification querySpecification)

Parameters

Type	Name	Description
MDXQuerySpecification	querySpecification	The query specification.

Returns

Type	Description
System.Int32[]	An integer array contains row and column count.

LoadOlapDataManager(OlapReport)

Loads the OlapDataManager based on the OlapReport.

Declaration

public void LoadOlapDataManager(OlapReport report)

Parameters

Type	Name	Description
OlapReport	report	The OLAP report.

LoadReport(String)

Loads the OLAP report.

Declaration

public void LoadReport(string reportName)

Parameters

Type	Name	Description
System.String	reportName	The name of the report.

LoadReportDefinitionFile(String)

Loads the report definition file.

Declaration

public void LoadReportDefinitionFile(string fileName)

Parameters

Type	Name	Description
System.String	fileName	The name of the file.

LoadReportDefinitionFromStream(Stream)

Loads the report definition from stream.

Declaration

public void LoadReportDefinitionFromStream(Stream reportStream)

Parameters

Type	Name	Description
System.IO.Stream	reportStream	The report as stream.

NotifyActiveReportChanged()

Notifies when the active report gets changed.

Declaration

public void NotifyActiveReportChanged()

NotifyActiveReportChanged(OlapReport)

Notifies when the specified active report gets changed

Declaration

public void NotifyActiveReportChanged(OlapReport report)

Parameters

Type	Name	Description
OlapReport	report	The active report.

NotifyActiveReportChanged(OlapReport, Boolean)

Notifies when the active report gets changed

Declaration

public void NotifyActiveReportChanged(OlapReport report, bool isReportChanged)

Parameters

Type	Name	Description
OlapReport	report	The active report.
System.Boolean	isReportChanged	Indicates whether the report is changed.

NotifyCellSetChanged(CellSet)

Notifies before the cell set gets returned.

Declaration

public void NotifyCellSetChanged(CellSet cellset)

Parameters

Type	Name	Description
CellSet	cellset

NotifyCellSetChanging()

Notifies when the new OLAP report is started to execute.

Declaration

public void NotifyCellSetChanging()

NotifyElementModified()

Notifies when the axis element gets modified.

Declaration

public void NotifyElementModified()

NotifyElementModified(AxisPosition)

Notifies when the element gets modified.

Declaration

public void NotifyElementModified(AxisPosition axisPosition)

Parameters

Type	Name	Description
AxisPosition	axisPosition	The axis position.

NotifyException(Exception)

Notifies when any exception is thrown.

Declaration

public void NotifyException(Exception exception)

Parameters

Type	Name	Description
System.Exception	exception

NotifyReportChanged()

Notifies when the report gets changed.

Declaration

public void NotifyReportChanged()

NotifyReportChanged(OlapReport)

Notifies when the specified report gets changed.

Declaration

public void NotifyReportChanged(OlapReport currentReport)

Parameters

Type	Name	Description
OlapReport	currentReport	The current report.

OnActiveReportChanged(Object, ActiveReportChangedEventArgs)

Called when the active report is changed.

Declaration

protected virtual void OnActiveReportChanged(object sender, ActiveReportChangedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender.
ActiveReportChangedEventArgs	e	The ActiveReportChangedEventArgs instance containing the event data.

OnAxisElementChanged(Object, AxisElementChangedEventArgs)

Called when the axis element is changed.

Declaration

protected virtual void OnAxisElementChanged(object sender, AxisElementChangedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender.
AxisElementChangedEventArgs	e	The AxisElementChangedEventArgs instance containing the event data.

OnAxisElementModified(Object, AxisElementModifiedEventArgs)

Called when the axis element is modified.

Declaration

protected virtual void OnAxisElementModified(object sender, AxisElementModifiedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender.
AxisElementModifiedEventArgs	e	The AxisElementModifiedEventArgs instance containing the event data.

OnCubeChanged(Object, CubeChangedEventArgs)

Called when the cube is changed.

Declaration

protected virtual void OnCubeChanged(object sender, CubeChangedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender.
CubeChangedEventArgs	e	The CubeChangedEventArgs instance containing the event data.

OnReportChanged(Object, ReportChangedEventArgs)

Called when the report is changed.

Declaration

protected virtual void OnReportChanged(object sender, ReportChangedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender.
ReportChangedEventArgs	e	The ReportChangedEventArgs instance containing the event data.

RaiseAxisElementModified()

Raises the event that is invoked when the axis element gets modified.

Declaration

public void RaiseAxisElementModified()

RemoveReport(String)

Removes the OLAP report.

Declaration

public void RemoveReport(string reportName)

Parameters

Type	Name	Description
System.String	reportName	The name of the report.

RenameReport(Int32, String)

Renames the OLAP report.

Declaration

public void RenameReport(int index, string newReportName)

Parameters

Type	Name	Description
System.Int32	index	The index of the report to be renamed.
System.String	newReportName	The new name of the report.

RenameReport(String, String)

Renames the OLAP report.

Declaration

public void RenameReport(string oldReportName, string newReportName)

Parameters

Type	Name	Description
System.String	oldReportName	The old name of the report.
System.String	newReportName	The new name of the report.

SaveReport(String)

Saves the OLAP report.

Declaration

public void SaveReport(string fileName)

Parameters

Type	Name	Description
System.String	fileName	The name of the file.

SetCurrentReport(OlapReport)

Sets the current report with the specified report.

Declaration

public void SetCurrentReport(OlapReport report)

Parameters

Type	Name	Description
OlapReport	report	The OLAP report.

ToggleAxis(OlapReport)

Transpose the data between the axis.

Declaration

public void ToggleAxis(OlapReport olapReport)