ProviderDictionary<TKey, TValue> Class

Provider dictionary.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractProviderDictionary
    CMS.DataEngine.ProviderDictionary<TKey, TValue>
      CMS.DataEngine.ProviderInfoDictionary<KeyType>
      CMS.DataEngine.ProviderStringDictionary
      CMS.DataEngine.ProviderStringValueDictionary<T>

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 8.2.23

Syntax

public class ProviderDictionary<TKey, TValue> : AbstractProviderDictionary, 
	IProviderDictionaryTemplate<TValue>

Type Parameters

TKey

TValue

The ProviderDictionary<TKey, TValue> type exposes the following members.

Constructors

	Name	Description
Public method	ProviderDictionary<TKey, TValue>	Constructor.

Methods

	Name	Description
Public method	Add(Object, TValue)	Adds the specified object.
Public method	Add(TKey, TValue)	Adds the specified object.
Public method	Add(TKey, TValue, Boolean)	Adds the specified object.
Public method	Clear	Clears all the items. (Overrides AbstractProviderDictionary.Clear(Boolean).)
Public method	ClearExpired	Clears all the expired items.
Protected method	ClearInternal	Clears the internal dictionary
Public method	ClearOlder	Removes the objects older that specified time.
Public method	Contains(Object)	Returns true if the table contains specified record.
Public method	Contains(TKey)	Returns true if the table contains specified record.
Public method	Contains(Object, TValue)	Returns true if the table contains specified record.
Public method	Contains(TKey, TValue)	Returns true if the table contains specified record.
Protected method	ContainsInternal	Returns true if the internal dictionary contains specified record.
Public method	ContainsKey	Returns true if the table contains specified record.
Protected method	ConvertKey	Converts the key to a specific type
Public method	Delete	Removes the specified object and logs the web farm task.
Public method Static member	GetDictionaries	Gets the Arraylist of dictionaries of specified object type.
Public method Static member	GetDictionaryName	Gets the provider name.
Public method	GetRealCount	Gets the real count of the objects in the dictionary
Protected method	CheckLogTask	Returns true if the logging of the tasks is enabled for the given object
Public method	Invalidate	Invalidates the dictionary content.
Public method	LoadNextGeneration	Loads the next generation of the objects.
Public method	LogWebFarmTask(String, String)	Logs the web farm task with specified task data.
Public method	LogWebFarmTask(TKey, String)	Logs the web farm task for specified object key.
Public method	NextGenerationAvailable	Returns true if the next generation of the objects is available.
Public method Static member	ProcessWebFarmTask	Processes the given web farm task.
Public method Static member	ReloadDictionaries	Reloads the dictionaries of specified object type.
Public method	Remove(Object)	Removes the specified object.
Public method	Remove(TKey)	Removes the specified object.
Public method	Remove(TKey, Boolean)	Removes the specified object.
Protected method	RemoveInternal	Removes the key from the internal dictionary
Protected method	TryGetInternal	Returns true if the internal dictionary contains specified record.
Public method	Update	Updates the specified object and logs the web farm task.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	DefaultWebFarmTaskType	Web farm task type to log
Protected field	mDataIsValid	True if the dictionary content is valid.
Protected field	mDictionary	Inner dictionary.
Protected field	mEnabled	If true, the provider functionality is enabled.
Protected field	mLogWebFarmTasks	Logs web farm tasks.
Protected field	mObjectLatency	Object latency of the hashtable.
Public field	mParentCollection	Parent dictionary collection.
Protected field	mReloadDictionary	If true, the dictionary should be reloaded.

Properties

	Name	Description
Public property	ColumnNames	Column names
Public property	Count	Items count (all keys).
Public property	DataIsValid	Returns true if the dictionary content is valid.
Protected property	Dictionary	Inner dictionary.
Public property	Enabled	If true, the dictionary is enabled.
Public property	IsEmpty	Returns true if the Dictionary is empty.
Public property	Item	Dictionary indexer.
Public property	LogWebFarmTasks	Gets / sets if the dictionary should log web farm tasks
Public property	Name	Dictionary name.
Public property	ObjectLatency	Object latency in minutes.
Public property	ObjectType	Object type
Public property	ParentCollection	Parent dictionary collection.
Public property	ReloadDictionary	If true, the dictionary should be reloaded. (Overrides AbstractProviderDictionary.ReloadDictionary.)
Public property	RemovedValue	Value that is set to the specific key if the value is removed. If not set, the item is completely removed.
Public property	UseWeakReferences	If true, the weak references are used for the items so the memory can be cleared upon request
Public property	Values	Returns the values of the dictionary