Class

XmlaDataProvider

Initializes a new instance of the XmlaDataProvider class with default XMLA web client. Sets up the provider for connecting to OLAP cubes through XML for Analysis protocol over HTTP.

Declaration

public XmlaDataProvider()

Gets a collection of XmlaAggregateDescription 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 using XMLA measures and calculated members.

Declaration

public Collection<XmlaAggregateDescription> AggregateDescriptions { get; }

Property Value

Gets a collection of XmlaGroupDescription 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 using XMLA dimensions.

Declaration

public Collection<XmlaGroupDescription> ColumnGroupDescriptions { get; }

Property Value

Gets or sets the connection settings used for establishing connection to the XMLA data server. These settings include server URL, database name, cube name, and authentication information required for XML for Analysis web service access.

Declaration

public XmlaConnectionSettings ConnectionSettings { get; set; }

Property Value

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

Declaration

public Collection<XmlaFilterDescription> FilterDescriptions { get; }

Property Value

Gets the current pivot calculation results containing the processed data from the XMLA 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

Overrides DataProviderBase.Results

Gets a collection of XmlaGroupDescription 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 using XMLA dimensions.

Declaration

public Collection<XmlaGroupDescription> RowGroupDescriptions { get; }

Property Value

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

Declaration

public override object State { get; }

Property Value

Overrides DataProviderBase.State

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

Declaration

public override void BlockUntilRefreshCompletes()

Exceptions

Overrides DataProviderBase.BlockUntilRefreshCompletes()

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

Declaration

protected override IFieldDescriptionProvider CreateFieldDescriptionsProvider()

Returns

Overrides DataProviderBase.CreateFieldDescriptionsProvider()

Creates an aggregate description for the specified field that can be used in XMLA 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

Returns

Overrides DataProviderBase.GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo)

Creates a filter description for the specified field that can be used in XMLA 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

Returns

Overrides DataProviderBase.GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo)

Creates a group description for the specified field that can be used in XMLA 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

Returns

Overrides DataProviderBase.GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo)

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

Declaration

protected override void RefreshOverride()

Overrides DataProviderBase.RefreshOverride()