Class AdomdDataProvider

Provides OLAP cube data access and operations using Microsoft Analysis Services through ADOMD.NET. This data provider enables pivot operations on multidimensional data sources with support for MDX queries, hierarchical dimensions, and cube-based aggregations.

Inheritance
System.Object
DataProviderBase
OlapDataProvider
AdomdDataProvider
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Pivot.Adomd
Assembly: Telerik.WinControls.PivotGrid.dll

Syntax

public sealed class AdomdDataProvider : OlapDataProvider, IDataProvider, INotifyPropertyChanged, ISupportInitialize

Constructors

AdomdDataProvider()

Initializes a new instance of the AdomdDataProvider class with default ADOMD client. Sets up the provider with deferred updates enabled for improved performance during configuration.

Declaration
public AdomdDataProvider()

Properties

AggregateDescriptions

Gets a collection of AdomdAggregateDescription objects that specify how data should be aggregated within the intersection of row and column groups. These define the calculated values displayed in pivot cells.

Declaration
public Collection<AdomdAggregateDescription> AggregateDescriptions { get; }
Property Value
System.Collections.ObjectModel.Collection<AdomdAggregateDescription>

ColumnGroupDescriptions

Gets a collection of AdomdGroupDescription objects that specify how the pivot data should be grouped by columns. Column groupings create the hierarchical structure displayed at the top of the pivot grid.

Declaration
public Collection<AdomdGroupDescription> ColumnGroupDescriptions { get; }
Property Value
System.Collections.ObjectModel.Collection<AdomdGroupDescription>

ConnectionSettings

Gets or sets the connection settings used for establishing connection to the Analysis Services data server. These settings include connection string, cube name, and authentication information required for ADOMD.NET access.

Declaration
public AdomdConnectionSettings ConnectionSettings { get; set; }
Property Value
AdomdConnectionSettings

The connection settings for the ADOMD data source.

FilterDescriptions

Gets a collection of AdomdFilterDescription objects that specify how pivot items should be filtered. Filters are applied to restrict the data included in pivot calculations and display.

Declaration
public Collection<AdomdFilterDescription> FilterDescriptions { get; }
Property Value
System.Collections.ObjectModel.Collection<AdomdFilterDescription>

Results

Gets the current pivot calculation results containing the processed data from the OLAP cube. This property provides access to the aggregated and grouped data ready for display in pivot controls.

Declaration
protected override IPivotResults Results { get; }
Property Value
IPivotResults

Overrides

RowGroupDescriptions

Gets a collection of AdomdGroupDescription objects that specify how the pivot data should be grouped by rows. Row groupings create the hierarchical structure displayed on the left side of the pivot grid.

Declaration
public Collection<AdomdGroupDescription> RowGroupDescriptions { get; }
Property Value
System.Collections.ObjectModel.Collection<AdomdGroupDescription>

State

Gets the current state object representing the connection settings for this data provider. This state is used for field description retrieval and connection management.

Declaration
public override object State { get; }
Property Value
System.Object

The ConnectionSettings object representing the current provider state.
Overrides

Methods

BlockUntilRefreshCompletes()

Blocks the calling thread until the current refresh operation completes. This method is not implemented for ADOMD data provider as it uses asynchronous operations.

Declaration
public override void BlockUntilRefreshCompletes()
Overrides
Exceptions
System.NotImplementedException

This method is not implemented for asynchronous ADOMD operations.

CreateFieldDescriptionsProvider()

Creates a field description provider for retrieving cube metadata and field information from the ADOMD data source. This provider is used to discover available dimensions, measures, and hierarchies in the connected cube.

Declaration
protected override IFieldDescriptionProvider CreateFieldDescriptionsProvider()
Returns
IFieldDescriptionProvider

A new AdomdFieldDescriptionProvider instance configured with the current connection settings.
Overrides

GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo)

Creates an aggregate description for the specified field that can be used in ADOMD pivot operations. The description is configured with the field name and initialized with the current provider context.

Declaration
protected override IAggregateDescription GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo description)
Parameters
IPivotFieldInfo description

The pivot field information to create an aggregate description for.
Returns
IAggregateDescription

An AdomdAggregateDescription configured for the specified field.
Overrides

GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo)

Creates a filter description for the specified field that can be used in ADOMD pivot filtering operations. The description is configured with the field name and initialized with the current provider context.

Declaration
protected override FilterDescription GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo description)
Parameters
IPivotFieldInfo description

The pivot field information to create a filter description for.
Returns
FilterDescription

An AdomdFilterDescription configured for the specified field.
Overrides

GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo)

Creates a group description for the specified field that can be used in ADOMD pivot grouping operations. The description is configured with the field name and initialized with the current provider context.

Declaration
protected override IGroupDescription GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo description)
Parameters
IPivotFieldInfo description

The pivot field information to create a group description for.
Returns
IGroupDescription

An AdomdGroupDescription configured for the specified field.
Overrides

RefreshOverride()

Performs the core refresh operation by generating MDX queries, executing them against the OLAP cube, and processing the results. This method handles field initialization, query generation, and result processing.

Declaration
protected override void RefreshOverride()
Overrides

Extension Methods