Class XmlaDataProvider

Provides Cube data access and operations using Xmla.

Inheritance
System.Object
DataProviderBase
OlapDataProvider
XmlaDataProvider
Inherited Members
Namespace: Telerik.Pivot.Xmla
Assembly: Telerik.Pivot.DataProviders.Xmla.dll

Syntax

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

Constructors

XmlaDataProvider()

Initializes a new instance of the XmlaDataProvider class.

Declaration
public XmlaDataProvider()

Properties

AggregateDescriptions

A list of XmlaAggregateDescription that specified how the pivot should be aggregated for the groups.

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

ColumnGroupDescriptions

A list of XmlaGroupDescription that specified how the pivot should be grouped by columns.

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

ConnectionSettings

Gets or sets the connection settings that are used for establishing connection to the data server.

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

The connection settings.

FilterDescriptions

A list of FilterDescription that specified how the pivot items should be filtered.

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

Results

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

Overrides

RowGroupDescriptions

A list of XmlaGroupDescription that specified how the pivot should be grouped by rows.

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

State

Gets the state object that is provided to GetDescriptionsDataAsync(Object) method.

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

The object that will be passed to GetDescriptionsDataAsync(Object) method.
Overrides

Methods

BlockUntilRefreshCompletes()

Block the calling thread until all calculations performed by calling Refresh() method completes.

Declaration
public override void BlockUntilRefreshCompletes()
Overrides

CreateFieldDescriptionsProvider()

Creates an instance of IFieldDescriptionProvider for this IDataProvider.

Declaration
protected override IFieldDescriptionProvider CreateFieldDescriptionsProvider()
Returns
IFieldDescriptionProvider

Overrides

GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo)

Creates and returns an aggregate description suitable for the supplied field description.

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

A IPivotFieldInfo instance.
Returns
IAggregateDescription

An IAggregateDescription instance.
Overrides

GetAggregateFunctionsForAggregateDescription(IAggregateDescription)

Returns a list of suitable functions for the supplied aggregate description.

Declaration
[Obsolete("Not used. Obsoleted after 2013.Q2.SP1")]
public override IEnumerable<object> GetAggregateFunctionsForAggregateDescription(IAggregateDescription aggregateDescription)
Parameters
IAggregateDescription aggregateDescription

The IAggregateDescription.
Returns
System.Collections.Generic.IEnumerable<System.Object>

A list of possible aggregate functions.
Overrides

GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo)

Returns a filter description suitable for the supplied field description.

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

A IPivotFieldInfo instance.
Returns
FilterDescription

An FilterDescription instance.
Overrides

GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo)

Creates and returns a group description suitable for the supplied field description.

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

A IPivotFieldInfo instance.
Returns
IGroupDescription

An IGroupDescription instance.
Overrides

RefreshOverride()

Recreates the Results.

Declaration
protected override void RefreshOverride()
Overrides

SetAggregateFunctionToAggregateDescription(IAggregateDescription, Object)

Set the aggregateFunction retrieved from GetAggregateFunctionsForAggregateDescription(IAggregateDescription) to the aggregateDescription.

Declaration
[Obsolete("Not used. Obsoleted after 2013.Q2.SP1")]
public override void SetAggregateFunctionToAggregateDescription(IAggregateDescription aggregateDescription, object aggregateFunction)
Parameters
IAggregateDescription aggregateDescription

The IAggregateDescription.
System.Object aggregateFunction

The aggregate function.
Overrides

Extension Methods