XmlaDataProvider
Provides OLAP cube data access and operations using XML for Analysis (XMLA) protocol. This data provider enables pivot operations on multidimensional data sources through XMLA web services, supporting MDX queries, hierarchical dimensions, and cube-based aggregations over HTTP/SOAP.
Definition
Namespace:Telerik.Pivot.Xmla
Assembly:Telerik.WinControls.PivotGrid.dll
Syntax:
public sealed class XmlaDataProvider : OlapDataProvider, IDataProvider, INotifyPropertyChanged, ISupportInitializeInheritance: objectDataProviderBaseOlapDataProviderXmlaDataProvider
Implements:
Inherited Members
Constructors
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.
public XmlaDataProvider()Properties
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.
public Collection<XmlaAggregateDescription> AggregateDescriptions { get; }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.
public Collection<XmlaGroupDescription> ColumnGroupDescriptions { get; }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.
public XmlaConnectionSettings ConnectionSettings { get; set; }The connection settings for the XMLA data source.
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.
public Collection<XmlaFilterDescription> FilterDescriptions { get; }Results
IPivotResults
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.
protected override IPivotResults Results { get; }Overrides:
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.
public Collection<XmlaGroupDescription> RowGroupDescriptions { get; }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.
public override object State { get; }The ConnectionSettings object representing the current provider state.
Overrides:
Methods
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.
public override void BlockUntilRefreshCompletes()This method is not implemented for asynchronous XMLA operations.
Overrides:
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.
protected override IFieldDescriptionProvider CreateFieldDescriptionsProvider()A new XmlaFieldDescriptionProvider instance configured with the current connection settings.
Overrides:
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.
protected override IAggregateDescription GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo description)The pivot field information to create an aggregate description for.
Returns:An XmlaAggregateDescription configured for the specified field.
Overrides:
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.
protected override FilterDescription GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo description)The pivot field information to create a filter description for.
Returns:An XmlaFilterDescription configured for the specified field.
Overrides:
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.
protected override IGroupDescription GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo description)The pivot field information to create a group description for.
Returns:An XmlaGroupDescription configured for the specified field.
Overrides:
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.
protected override void RefreshOverride()Overrides: