Documentation

Class DataProviderBase

Base implementation of IDataProvider.

Inheritance
System.Object
DataProviderBase
LocalDataSourceProvider
OlapDataProvider
QueryableDataProvider
Namespace: Telerik.Pivot.Core
Assembly: Telerik.Pivot.Core.dll

Syntax

public abstract class DataProviderBase : Freezable, IDataProvider, INotifyPropertyChanged, ISupportInitialize

Properties

AggregatesLevel

Declaration
public int AggregatesLevel { get; set; }
Property Value
System.Int32

AggregatesPosition

Declaration
public PivotAxis AggregatesPosition { get; set; }
Property Value
PivotAxis

DeferUpdates

Gets or sets a value that indicates if changes to this IDataProvider will trigger automatic Refresh().

Declaration
public bool DeferUpdates { get; set; }
Property Value
System.Boolean

Implements

FieldDescriptionsProvider

Declaration
public IFieldDescriptionProvider FieldDescriptionsProvider { get; set; }
Property Value
IFieldDescriptionProvider

FieldInfos

Gets the IFieldInfoData instance that provided information for all available properties of the data source.

Declaration
public IFieldInfoData FieldInfos { get; protected set; }
Property Value
IFieldInfoData

The field information.
Implements

HasPendingChanges

Gets a value that indicates if there are pending changes since the last Refresh(). The value will be true after a change is applied. The value will be false after an automatic or user triggered Refresh(). The value will be false during any work or download process so even if false Results may not be ready yet. In that case you may check Status for additional information.

Declaration
public bool HasPendingChanges { get; }
Property Value
System.Boolean

Implements

Results

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

Settings

Declaration
protected IPivotSettings Settings { get; }
Property Value
IPivotSettings

State

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

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

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

Status

Declaration
public DataProviderStatus Status { get; }
Property Value
DataProviderStatus

Methods

BeginInit()

Declaration
public void BeginInit()

BlockUntilRefreshCompletes()

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

Declaration
public abstract void BlockUntilRefreshCompletes()
Implements

CreateFieldDescriptionsProvider()

Creates an instance of IFieldDescriptionProvider for this IDataProvider.

Declaration
protected abstract IFieldDescriptionProvider CreateFieldDescriptionsProvider()
Returns
IFieldDescriptionProvider

CreateInstanceCore()

Declaration
protected override sealed Freezable CreateInstanceCore()
Returns
System.Windows.Freezable

DeferRefresh()

Enters a defer cycle that you can use to merge changes to the provider and delay automatic refresh.

Declaration
public IDisposable DeferRefresh()
Returns
System.IDisposable

An System.IDisposable object that you can use to dispose of the calling object.
Implements

EndInit()

Declaration
public void EndInit()

FreezeCore(Boolean)

Declaration
protected override sealed bool FreezeCore(bool isChecking)
Parameters
System.Boolean isChecking

Returns
System.Boolean

GetAggregateDescriptionForFieldDescription(IPivotFieldInfo)

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

Declaration
public IAggregateDescription GetAggregateDescriptionForFieldDescription(IPivotFieldInfo info)
Parameters
IPivotFieldInfo info

A IPivotFieldInfo instance.
Returns
IAggregateDescription

An IAggregateDescription instance.
Implements

GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo)

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

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

A IPivotFieldInfo instance.
Returns
IAggregateDescription

An IAggregateDescription instance.

GetAggregateFunctionsForAggregateDescription(IAggregateDescription)

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

Declaration
public abstract IEnumerable<object> GetAggregateFunctionsForAggregateDescription(IAggregateDescription aggregateDescription)
Parameters
IAggregateDescription aggregateDescription

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

A list of possible aggregate functions.
Implements

GetFilterDescriptionForFieldDescription(IPivotFieldInfo)

Returns a filter description suitable for the supplied field description.

Declaration
public FilterDescription GetFilterDescriptionForFieldDescription(IPivotFieldInfo info)
Parameters
IPivotFieldInfo info

A IPivotFieldInfo instance.
Returns
FilterDescription

An FilterDescription instance.
Implements

GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo)

Returns a filter description suitable for the supplied field description.

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

A IPivotFieldInfo instance.
Returns
FilterDescription

An FilterDescription instance.

GetGroupDescriptionForFieldDescription(IPivotFieldInfo)

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

Declaration
public IGroupDescription GetGroupDescriptionForFieldDescription(IPivotFieldInfo info)
Parameters
IPivotFieldInfo info

A IPivotFieldInfo instance.
Returns
IGroupDescription

An IGroupDescription instance.
Implements

GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo)

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

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

A IPivotFieldInfo instance.
Returns
IGroupDescription

An IGroupDescription instance.

Invalidate()

Notify that changes were applied that would alter the pivot results. Queues an automatic Refresh().

Declaration
protected void Invalidate()

OnFieldDescriptionsProviderChanged(IFieldDescriptionProvider, IFieldDescriptionProvider)

Called when FieldDescriptionsProvider is changed.

Declaration
protected virtual void OnFieldDescriptionsProviderChanged(IFieldDescriptionProvider oldProvider, IFieldDescriptionProvider newProvider)
Parameters
IFieldDescriptionProvider oldProvider

IFieldDescriptionProvider newProvider

OnPrepareDescriptionForField(PrepareDescriptionForFieldEventArgs)

Raises the PrepareDescriptionForField event.

Declaration
protected virtual void OnPrepareDescriptionForField(PrepareDescriptionForFieldEventArgs args)
Parameters
PrepareDescriptionForFieldEventArgs args

The PrepareDescriptionForFieldEventArgs instance containing the event data.

OnPropertyChanged(String)

Raises PropertyChanged event.

Declaration
protected void OnPropertyChanged(string propertyName)
Parameters
System.String propertyName

OnStatusChanged(DataProviderStatusChangedEventArgs)

Raises the StatusChanged event.

Declaration
protected virtual void OnStatusChanged(DataProviderStatusChangedEventArgs args)
Parameters
DataProviderStatusChangedEventArgs args

The DataProviderStatusChangedEventArgs instance containing the event data.

Refresh()

Declaration
public void Refresh()

RefreshOverride()

Recreates the Results.

Declaration
protected abstract void RefreshOverride()

SetAggregateFunctionToAggregateDescription(IAggregateDescription, Object)

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

Declaration
public abstract void SetAggregateFunctionToAggregateDescription(IAggregateDescription aggregateDescription, object aggregateFunction)
Parameters
IAggregateDescription aggregateDescription

The IAggregateDescription.
System.Object aggregateFunction

The aggregate function.
Implements

Events

PrepareDescriptionForField

Occurs when description should be prepared for a specified field info.

Declaration
public event EventHandler<PrepareDescriptionForFieldEventArgs> PrepareDescriptionForField
Event Type
System.EventHandler<PrepareDescriptionForFieldEventArgs>

Implements

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
System.ComponentModel.PropertyChangedEventHandler

StatusChanged

Declaration
public event EventHandler<DataProviderStatusChangedEventArgs> StatusChanged
Event Type
System.EventHandler<DataProviderStatusChangedEventArgs>

Explicit Interface Implementations

IDataProvider.AggregatesLevel

Gets or sets the position where groups for the aggregates should be placed.

Declaration
int IDataProvider.AggregatesLevel { get; set; }
Returns
System.Int32

Implements

IDataProvider.AggregatesPosition

Gets or sets a value indicating where the aggregate groups should be positioned.

Declaration
PivotAxis IDataProvider.AggregatesPosition { get; set; }
Returns
PivotAxis

Implements

IDataProvider.Refresh()

Force recalculation operation.

Declaration
void IDataProvider.Refresh()
Implements

IDataProvider.Results

Gets the results from the last grouping.

Declaration
IPivotResults IDataProvider.Results { get; }
Returns
IPivotResults

Implements

IDataProvider.Settings

Gets or sets the IPivotSettings instance that is being used.

Declaration
IPivotSettings IDataProvider.Settings { get; }
Returns
IPivotSettings

Implements

IDataProvider.Status

Gets the status of this instance.

Declaration
DataProviderStatus IDataProvider.Status { get; }
Returns
DataProviderStatus

Implements

IDataProvider.StatusChanged

Occurs when the current operation has completed.

Declaration
event EventHandler<DataProviderStatusChangedEventArgs> IDataProvider.StatusChanged
Returns
System.EventHandler<DataProviderStatusChangedEventArgs>

Implements

Extension Methods