ClassDataProviderBase
Base implementation of IDataProvider.
Definition
Namespace:Telerik.Pivot.Core
Assembly:Telerik.Pivot.Core.dll
Syntax:
public abstract class DataProviderBase : Freezable, IDataProvider, INotifyPropertyChanged, ISupportInitializeInheritance: objectDataProviderBase
Derived Classes:
Implements:
Properties
AggregatesPosition
Declaration
public PivotAxis AggregatesPosition { get; set; }Property Value
DeferUpdates
Gets or sets a value that indicates if changes to this IDataProvider will trigger automatic Refresh().
FieldDescriptionsProvider
Declaration
public IFieldDescriptionProvider FieldDescriptionsProvider { get; set; }Property Value
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
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.
Results
Declaration
protected abstract IPivotResults Results { get; }Property Value
IPivotResults
Settings
Declaration
protected IPivotSettings Settings { get; }Property Value
State
Gets the state object that is provided to GetDescriptionsDataAsync(object) method.
Declaration
public abstract object State { get; }Property Value
The object that will be passed to GetDescriptionsDataAsync(object) method.
Implements
Status
Declaration
public DataProviderStatus Status { get; }Property Value
Methods
BeginInit()
Declaration
public void BeginInit()Implements
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
CreateInstanceCore()
Declaration
[SuppressMessage("Microsoft.Naming", "CA2204:Literals should be spelled correctly", MessageId = "CreateInstanceCore", Justification = "CreateInstanceCore is the name of the inherited and overriden method from Freezable.")]
[SuppressMessage("Microsoft.Naming", "CA2204:Literals should be spelled correctly", MessageId = "DataProviderBase", Justification = "DataProviderBase is the name of the class.")]
protected override sealed Freezable CreateInstanceCore()Returns
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
An IDisposable object that you can use to dispose of the calling object.
Implements
EndInit()
Declaration
public void EndInit()Implements
FreezeCore(bool)
Declaration
[SuppressMessage("Microsoft.Naming", "CA2204:Literals should be spelled correctly", MessageId = "DataProviderBase", Justification = "DataProviderBase is the name of the class.")]
protected override sealed bool FreezeCore(bool isChecking)Parameters
isChecking
Returns
GetAggregateDescriptionForFieldDescription(IPivotFieldInfo)
Creates and returns an aggregate description suitable for the supplied field description.
Declaration
public IAggregateDescription GetAggregateDescriptionForFieldDescription(IPivotFieldInfo info)Parameters
info
A IPivotFieldInfo instance.
Returns
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
description
A IPivotFieldInfo instance.
Returns
An IAggregateDescription instance.
GetAggregateFunctionsForAggregateDescription(IAggregateDescription)
Returns a list of suitable functions for the supplied aggregate description.
Declaration
[Obsolete("Not used. Obsoleted after 2013.Q2.SP1")]
public abstract IEnumerable<object> GetAggregateFunctionsForAggregateDescription(IAggregateDescription aggregateDescription)Parameters
aggregateDescription
Returns
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
info
A IPivotFieldInfo instance.
Returns
An FilterDescription instance.
Implements
GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo)
Returns a filter description suitable for the supplied field description.
Declaration
protected abstract FilterDescription GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo description)Parameters
description
A IPivotFieldInfo instance.
Returns
An FilterDescription instance.
GetGroupDescriptionForFieldDescription(IPivotFieldInfo)
Creates and returns a group description suitable for the supplied field description.
Declaration
public IGroupDescription GetGroupDescriptionForFieldDescription(IPivotFieldInfo info)Parameters
info
A IPivotFieldInfo instance.
Returns
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
description
A IPivotFieldInfo instance.
Returns
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
oldProvider
newProvider
OnPrepareDescriptionForField(PrepareDescriptionForFieldEventArgs)
Raises the event.
Declaration
protected virtual void OnPrepareDescriptionForField(PrepareDescriptionForFieldEventArgs args)Parameters
args
PrepareDescriptionForFieldEventArgs
The PrepareDescriptionForFieldEventArgs instance containing the event data.
OnPropertyChanged(string)
Raises PropertyChanged event.
Declaration
protected void OnPropertyChanged(string propertyName)Parameters
propertyName
OnStatusChanged(DataProviderStatusChangedEventArgs)
Raises the event.
Declaration
protected virtual void OnStatusChanged(DataProviderStatusChangedEventArgs args)Parameters
args
DataProviderStatusChangedEventArgs
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
[Obsolete("Not used. Obsoleted after 2013.Q2.SP1")]
public abstract void SetAggregateFunctionToAggregateDescription(IAggregateDescription aggregateDescription, object aggregateFunction)Parameters
aggregateDescription
aggregateFunction
The aggregate function.
Implements
Events
PrepareDescriptionForField
Occurs when description should be prepared for a specified field info.
Declaration
public event EventHandler<PrepareDescriptionForFieldEventArgs> PrepareDescriptionForFieldEvent Value
Implements
PropertyChanged
Declaration
public event PropertyChangedEventHandler PropertyChangedEvent Value
Implements
StatusChanged
Declaration
public event EventHandler<DataProviderStatusChangedEventArgs> StatusChangedEvent Value