ClassXmlaDataProvider
Provides Cube data access and operations using Xmla.
Definition
Namespace:Telerik.Pivot.Xmla
Assembly:Telerik.Pivot.DataProviders.Xmla.dll
Syntax:
public sealed class XmlaDataProvider : OlapDataProvider, IDataProvider, INotifyPropertyChanged, ISupportInitializeInheritance: objectDataProviderBaseOlapDataProviderXmlaDataProvider
Implements:
Inherited Members
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
[SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Design choice.")]
public Collection<XmlaAggregateDescription> AggregateDescriptions { get; }Property Value
ColumnGroupDescriptions
A list of XmlaGroupDescription that specified how the pivot should be grouped by columns.
Declaration
[SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Design choice.")]
public Collection<XmlaGroupDescription> ColumnGroupDescriptions { get; }Property Value
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
The connection settings.
FilterDescriptions
A list of FilterDescription that specified how the pivot items should be filtered.
Declaration
[SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Design choice.")]
public Collection<XmlaFilterDescription> FilterDescriptions { get; }Property Value
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
[SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Design choice.")]
public Collection<XmlaGroupDescription> RowGroupDescriptions { get; }Property Value
State
Gets the state object that is provided to GetDescriptionsDataAsync(object) method.
Declaration
public override object State { get; }Property Value
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
Overrides
GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo)
Creates and returns an aggregate description suitable for the supplied field description.
Declaration
protected override IAggregateDescription GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo description)Parameters
description
A IPivotFieldInfo instance.
Returns
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
aggregateDescription
Returns
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
description
A IPivotFieldInfo instance.
Returns
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
description
A IPivotFieldInfo instance.
Returns
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
aggregateDescription
aggregateFunction
The aggregate function.
Overrides