MultiDictionaryBase(TKey, TValue) Class

MultiDictionaryBaseTKey, TValue Class

MultiDictionaryBase is a base class that can be used to more easily implement a class that associates multiple values to a single key. The class implements the generic IDictionary<TKey, ICollection<TValue>> interface.

Inheritance Hierarchy

SystemObject
  X3Platform.CollectionsCollectionBaseKeyValuePairTKey, ICollectionTValue
    X3Platform.CollectionsMultiDictionaryBaseTKey, TValue
      X3Platform.CollectionsMultiDictionaryTKey, TValue
      X3Platform.CollectionsOrderedMultiDictionaryTKey, TValue
      X3Platform.CollectionsOrderedMultiDictionaryTKey, TValueView

Namespace: X3Platform.Collections
Assembly: X3Platform.Support (in X3Platform.Support.dll) Version: 1.0.0.0 (2.0.0.0)

Syntax

C++

Copy

[SerializableAttribute]
public abstract class MultiDictionaryBase<TKey, TValue> : CollectionBase<KeyValuePair<TKey, ICollection<TValue>>>, 
	IDictionary<TKey, ICollection<TValue>>, ICollection<KeyValuePair<TKey, ICollection<TValue>>>, 
	IEnumerable<KeyValuePair<TKey, ICollection<TValue>>>, IEnumerable

[SerializableAttribute]
generic<typename TKey, typename TValue>
public ref class MultiDictionaryBase abstract : public CollectionBase<KeyValuePair<TKey, ICollection<TValue>^>>, 
	IDictionary<TKey, ICollection<TValue>^>, ICollection<KeyValuePair<TKey, ICollection<TValue>^>>, 
	IEnumerable<KeyValuePair<TKey, ICollection<TValue>^>>, IEnumerable

Type Parameters

TKey: The key type of the dictionary.
TValue: The value type of the dictionary.

The MultiDictionaryBaseTKey, TValue type exposes the following members.

Constructors

	Name	Description
	MultiDictionaryBaseTKey, TValue	Initializes a new instance of the MultiDictionaryBaseTKey, TValue class

Top

Methods

	Name	Description
	Add(KeyValuePairTKey, ICollectionTValue)	Adds a key-value pair to the collection. The value part of the pair must be a collection of values to associate with the key. If values are already associated with the given key, the new values are added to the ones associated with that key. (Overrides CollectionBaseTAdd(T).)
	Add(TKey, TValue)	Adds a new key-value pair to the dictionary. This method must be overridden in the derived class.
	AddMany	Adds new values to be associated with a key. If duplicate values are permitted, this method always adds new key-value pairs to the dictionary. If duplicate values are not permitted, and key already has a value equal to one of values associated with it, then that value is replaced, and the number of values associate with key is unchanged.
	AsReadOnly	Provides a read-only view of this collection. The returned ICollection<T> provides a view of the collection that prevents modifications to the collection. Use the method to provide access to the collection without allowing changes. Since the returned object is just a view, changes to the collection will be reflected in the view. (Inherited from CollectionBaseT.)
	Clear	Clears the dictionary. This method must be overridden in the derived class. (Overrides CollectionBaseTClear.)
	Contains(KeyValuePairTKey, ICollectionTValue)	Determines if this dictionary contains the given key and all of the values associated with that key.. (Overrides CollectionBaseTContains(T).)
	Contains(TKey, TValue)	Determines if this dictionary contains a key-value pair equal to key and value. The dictionary is not changed. This method must be overridden in the derived class.
	ContainsKey	Determines whether a given key is found in the dictionary.
	ConvertAllTOutput	Convert this collection of items by applying a delegate to each item in the collection. The resulting enumeration contains the result of applying converter to each item in this collection, in order. (Inherited from CollectionBaseT.)
	CopyTo	Copies all the items in the collection into an array. Implemented by using the enumerator returned from GetEnumerator to get all the items and copy them to the provided array. (Inherited from CollectionBaseT.)
	CountAllValues	Gets a total count of values in the collection. This default implementation is slow; it enumerates all of the keys in the dictionary and calls CountValues on each. A derived class may be able to supply a more efficient implementation.
	CountValues	Gets a count of the number of values associated with a key. The default implementation is slow; it enumerators all of the values (using TryEnumerateValuesForKey) to count them. A derived class may be able to supply a more efficient implementation.
	CountWhere	Counts the number of items in the collection that satisfy the condition defined by predicate. (Inherited from CollectionBaseT.)
	EnumerateKeys	Enumerate all the keys in the dictionary. This method must be overridden by a derived class.
	Equals	(Inherited from Object.)
	EqualValues	If the derived class does not use the default comparison for values, this methods should be overridden to compare two values for equality. This is used for the correct implementation of ICollection.Contains on the Values and KeyValuePairs collections.
	Exists	Determines if the collection contains any item that satisfies the condition defined by predicate. (Inherited from CollectionBaseT.)
	Finalize	(Inherited from Object.)
	FindAll	Enumerates the items in the collection that satisfy the condition defined by predicate. (Inherited from CollectionBaseT.)
	ForEach	Performs the specified action on each item in this collection. (Inherited from CollectionBaseT.)
	GetEnumerator	Enumerate all the keys in the dictionary, and for each key, the collection of values for that key. (Overrides CollectionBaseTGetEnumerator.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	Remove(KeyValuePairTKey, ICollectionTValue)	Removes a set of values from a given key. If all values associated with a key are removed, then the key is removed also. (Overrides CollectionBaseTRemove(T).)
	Remove(TKey)	Removes a key from the dictionary. This method must be overridden in the derived class.
	Remove(TKey, TValue)	Removes a key-value pair from the dictionary. This method must be overridden in the derived class.
	RemoveAll	Removes all the items in the collection that satisfy the condition defined by predicate. (Inherited from CollectionBaseT.)
	RemoveMany(IEnumerableTKey)	Remove all of the keys (and any associated values) in a collection of keys. If a key is not present in the dictionary, nothing happens.
	RemoveMany(TKey, IEnumerableTValue)	Removes a collection of values from the values associated with a key. If the last value is removed from a key, the key is removed also.
	Replace	Replaces all values associated with key with the single value value.
	ReplaceMany	Replaces all values associated with key with a new collection of values. If the collection does not permit duplicate values, and values has duplicate items, then only the last of duplicates is added.
	ToArray	Creates an array of the correct size, and copies all the items in the collection into the array, by calling CopyTo. (Inherited from CollectionBaseT.)
	ToString	Shows the string representation of the dictionary. The string representation contains a list of the mappings in the dictionary. (Overrides CollectionBaseTToString.)
	TrueForAll	Determines if all of the items in the collection satisfy the condition defined by predicate. (Inherited from CollectionBaseT.)
	TryEnumerateValuesForKey	Enumerate all of the values associated with a given key. This method must be overridden by the derived class. If the key exists and has values associated with it, an enumerator for those values is returned throught values. If the key does not exist, false is returned.

Top

Properties

	Name	Description
	Count	Gets the number of keys in the dictionary. This property must be overridden in the derived class. (Overrides CollectionBaseTCount.)
	Item	Returns a collection of all of the values in the dictionary associated with key, or changes the set of values associated with key. If the key is not present in the dictionary, an ICollection enumerating no values is returned. The returned collection of values is read-write, and can be used to modify the collection of values associated with the key.
	Keys	Gets a read-only collection all the keys in this dictionary.
	KeyValuePairs	Gets a read-only collection of all key-value pairs in the dictionary. If a key has multiple values associated with it, then a key-value pair is present for each value associated with the key.
	Values	Gets a read-only collection of all the values in the dictionary.

Top

Remarks

To use MultiDictionaryBase as a base class, the derived class must override Count, Clear, Add, Remove(TKey), Remove(TKey,TValue), Contains(TKey,TValue), EnumerateKeys, and TryEnumerateValuesForKey.

It may wish consider overriding CountValues, CountAllValues, ContainsKey, and EqualValues, but these are not required.

Reference

X3Platform.Collections Namespace