Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue > Class Template Reference

Abstraction of CompositeDictionary. More...

Inheritance diagram for Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >:

List of all members.

Public Member Functions
void	Put (TPrimaryKey primaryKey, TSecondaryKey secondaryKey, TValue value)
	Puts value by primary and secondary key.
void	Put (CompositeKey< TPrimaryKey, TSecondaryKey > key, TValue value)
	Puts value by composite key.
void	PutAll (CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue > compositeDictionary)
	Puts all values from composite dictionary.
void	PutAll (IDictionary< TPrimaryKey, IDictionary< TSecondaryKey, TValue >> dictionary)
	Puts all values from dictionary.
TValue	Get (CompositeKey< TPrimaryKey, TSecondaryKey > key)
	Returns value for composite key.
TValue	Get (TPrimaryKey primaryKey, TSecondaryKey secondaryKey)
	Returns value for primary and secondary key.
ICollection< TValue >	PrimaryKeyValues (TPrimaryKey primaryKey)
	Returns all values for primary key.
ICollection< TValue >	SecondaryKeyValues (TSecondaryKey secondaryKey)
	Returns all values for secondary key.
void	Clear ()
	Removes all entries.
ICollection< KeyValuePair < TSecondaryKey, TValue > >	PrimaryKeyEntries (TPrimaryKey primaryKey)
	Returns all entries for primary key.
ICollection< KeyValuePair < TPrimaryKey, TValue > >	SecondaryKeyEntries (TSecondaryKey secondaryKey)
	Returns all entries for secondary key.
bool	Remove (TPrimaryKey primaryKey, TSecondaryKey secondaryKey)
	Removes value by primary and secondary key.
bool	Remove (CompositeKey< TPrimaryKey, TSecondaryKey > key)
	Removes value by composite key.
ICollection< TValue >	RemoveByPrimaryKey (TPrimaryKey primaryKey)
	Removes all values by primary key.
ICollection< TValue >	RemoveBySecondaryKey (TSecondaryKey secondaryKey)
	Removes all values by secondary key.
bool	ContainsKey (TPrimaryKey primaryKey, TSecondaryKey secondaryKey)
	Checks is dictionary contains primary and secondary key.
bool	ContainsKey (CompositeKey< TPrimaryKey, TSecondaryKey > key)
	Checks is dictionary contains composite key.
bool	ContainsValue (TValue value)
	Checks is dictionary contains value.
bool	ContainsPrimaryKeyValue (TPrimaryKey primaryKey, TValue value)
	Checks is dictionary contains value mapped by primary key.
bool	ContainsSecondaryKeyValue (TSecondaryKey secondaryKey, TValue value)
	Checks is dictionary contains value mapped by secondary key.
bool	ContainsEntry (TPrimaryKey primaryKey, TSecondaryKey secondaryKey, TValue value)
	Checks is dictionary contains entry of primary-secondary-key, value.
bool	ContainsEntry (CompositeKey< TPrimaryKey, TSecondaryKey > key, TValue value)
	Checks is dictionary contains entry.
IDictionary< TPrimaryKey, IDictionary< TSecondaryKey, TValue > >	ToDictionary ()
	Converts CompositeDictionary to regular dictionary.
override bool	Equals (object obj)
override int	GetHashCode ()
override string	ToString ()
Protected Member Functions
abstract IDictionary< T, TV >	CreateDictionary< T, TV > (int capacity)
	Creates dictionary with given capacity.
abstract IDictionary< T, TV >	CreateDictionary< T, TV > ()
	Creates dictionary.
abstract ICollection< T >	CreateList< T > (int capacity)
	Creates list matching CompositDictionary implementatio with given capacity.
abstract ICollection< T >	CreateList< T > ()
	Creates list matching CompositDictionary implementation.
abstract ISet< T >	CreateSet< T > ()
	Creates set.
Properties
int	Count [get, set]
	Returns all values count.
TValue	this[CompositeKey< TPrimaryKey, TSecondaryKey > key] [get]
	Returns value for composite key.
ICollection< TValue >	Values [get]
	Returns all values.
ISet< CompositeKey < TPrimaryKey, TSecondaryKey > >	Keys [get]
	Returns set of composite keys.
ISet< TPrimaryKey >	PrimaryKeys [get]
	Retunrs set of primary keys.
ISet< TSecondaryKey >	SecondaryKeys [get]
	Retunrs set of secondary keys.
int	PrimaryKeysCount [get]
	Returns number of primary keys.
bool	IsEmpty [get]
	Checks if dictionary is empty.
ICollection< KeyValuePair < TPrimaryKey, KeyValuePair < TSecondaryKey, TValue > > >	Entries [get]
	Returns all entries.

---

Detailed Description

template<TPrimaryKey, TSecondaryKey, TValue>
class Sharpility::Collections::AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >

Abstraction of CompositeDictionary.

Template Parameters:

TPrimaryKey	Type of primary key
TSecondaryKey	Type of secondary key
TValue	Type of value

---

Member Function Documentation

template<TPrimaryKey , TSecondaryKey , TValue >

void Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.Clear

(

)

[inline]

Removes all entries.

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

bool Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.ContainsEntry	(	TPrimaryKey	primaryKey,
		TSecondaryKey	secondaryKey,
		TValue	value
	)		[inline]

Checks is dictionary contains entry of primary-secondary-key, value.

Parameters:

primaryKey	Primary key value
secondaryKey	Secondary key value
value	Checked value

Returns:

true if given value is mapped by given primary and secondary key

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

bool Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.ContainsEntry	(	CompositeKey< TPrimaryKey, TSecondaryKey >	key,
		TValue	value
	)		[inline]

Checks is dictionary contains entry.

Parameters:

key	Entry key
value	Checked value

Returns:

true if given value is mapped by given key

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

bool Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.ContainsKey	(	TPrimaryKey	primaryKey,
		TSecondaryKey	secondaryKey
	)		[inline]

Checks is dictionary contains primary and secondary key.

Parameters:

primaryKey	Primary key value
secondaryKey	Secondary key value

Returns:

true if dictionary contains primary and secondary key

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

bool Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.ContainsKey

(

CompositeKey< TPrimaryKey, TSecondaryKey >

key

)

[inline]

Checks is dictionary contains composite key.

Parameters:

key	Composite key value

Returns:

true if dictionary contains primary and secondary key

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

bool Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.ContainsPrimaryKeyValue	(	TPrimaryKey	primaryKey,
		TValue	value
	)		[inline]

Checks is dictionary contains value mapped by primary key.

Parameters:

primaryKey	Primary key value
value	Checked value

Returns:

true if dictionary contains value for given primary key

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

bool Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.ContainsSecondaryKeyValue	(	TSecondaryKey	secondaryKey,
		TValue	value
	)		[inline]

Checks is dictionary contains value mapped by secondary key.

Parameters:

secondaryKey	Secondary key value
value	Checked value

Returns:

true if dictionary contains value for given secondary key

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

bool Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.ContainsValue

(

TValue

value

)

[inline]

Checks is dictionary contains value.

Parameters:

value

Checked value

Returns:

true if dictionary contains given value

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

abstract IDictionary<T, TV> Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.CreateDictionary< T, TV >

(

int

capacity

)

[protected, pure virtual]

Creates dictionary with given capacity.

Template Parameters:

T	Type of key
TV	Type of value

Parameters:

capacity

Dictionary capacity

Returns:

created dictionary

Implemented in Sharpility.Collections.HashCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

abstract IDictionary<T, TV> Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.CreateDictionary< T, TV >

(

)

[protected, pure virtual]

Creates dictionary.

Template Parameters:

T	Type of key
TV	Type of value

Returns:

created dictionary

Implemented in Sharpility.Collections.HashCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

abstract ICollection<T> Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.CreateList< T >

(

int

capacity

)

[protected, pure virtual]

Creates list matching CompositDictionary implementatio with given capacity.

Template Parameters:

T	Type of list item

Parameters:

capacity

List capacity

Returns:

created list

Implemented in Sharpility.Collections.HashCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

abstract ICollection<T> Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.CreateList< T >

(

)

[protected, pure virtual]

Creates list matching CompositDictionary implementation.

Template Parameters:

T	Type of list item

Returns:

created list

Implemented in Sharpility.Collections.HashCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

abstract ISet<T> Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.CreateSet< T >

(

)

[protected, pure virtual]

Creates set.

Template Parameters:

T	Type of set

Returns:

created set

Implemented in Sharpility.Collections.HashCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

TValue Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.Get

(

CompositeKey< TPrimaryKey, TSecondaryKey >

key

)

[inline]

Returns value for composite key.

Parameters:

key	Composite key of primary and secondary key

Returns:

Value

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

TValue Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.Get	(	TPrimaryKey	primaryKey,
		TSecondaryKey	secondaryKey
	)		[inline]

Returns value for primary and secondary key.

Parameters:

primaryKey	Primary key value
secondaryKey	Secondary key value

Returns:

Value

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

ICollection<KeyValuePair<TSecondaryKey, TValue> > Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.PrimaryKeyEntries

(

TPrimaryKey

primaryKey

)

[inline]

Returns all entries for primary key.

Parameters:

primaryKey

Primary key value

Returns:

Primary key entries

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

ICollection<TValue> Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.PrimaryKeyValues

(

TPrimaryKey

primaryKey

)

[inline]

Returns all values for primary key.

Parameters:

primaryKey

Primary key

Returns:

Values

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

void Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.Put	(	TPrimaryKey	primaryKey,
		TSecondaryKey	secondaryKey,
		TValue	value
	)		[inline]

Puts value by primary and secondary key.

Parameters:

primaryKey	Primary key value
secondaryKey	Secondary key value
value	Value

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

void Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.Put	(	CompositeKey< TPrimaryKey, TSecondaryKey >	key,
		TValue	value
	)		[inline]

Puts value by composite key.

Parameters:

key	Composite key of primary and secondary key
value	Value

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

void Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.PutAll

(

CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >

compositeDictionary

)

[inline]

Puts all values from composite dictionary.

Parameters:

compositeDictionary

CompositeDictionary

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

void Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.PutAll

(

IDictionary< TPrimaryKey, IDictionary< TSecondaryKey, TValue >>

dictionary

)

[inline]

Puts all values from dictionary.

Parameters:

dictionary

Dictionary

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

bool Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.Remove	(	TPrimaryKey	primaryKey,
		TSecondaryKey	secondaryKey
	)		[inline]

Removes value by primary and secondary key.

Parameters:

primaryKey	Primary key value
secondaryKey	Secondary key value

Returns:

true if value was removed

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

bool Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.Remove

(

CompositeKey< TPrimaryKey, TSecondaryKey >

key

)

[inline]

Removes value by composite key.

Parameters:

key	Composite key of primary and secondary key

Returns:

true if value was removed

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

ICollection<TValue> Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.RemoveByPrimaryKey

(

TPrimaryKey

primaryKey

)

[inline]

Removes all values by primary key.

Parameters:

primaryKey

Primary key value

Returns:

Removed values

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

ICollection<TValue> Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.RemoveBySecondaryKey

(

TSecondaryKey

secondaryKey

)

[inline]

Removes all values by secondary key.

Parameters:

secondaryKey

Secondary key value

Returns:

Removed values

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

ICollection<KeyValuePair<TPrimaryKey, TValue> > Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.SecondaryKeyEntries

(

TSecondaryKey

secondaryKey

)

[inline]

Returns all entries for secondary key.

Parameters:

secondaryKey

Secondary key value

Returns:

Secondary key entries

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

ICollection<TValue> Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.SecondaryKeyValues

(

TSecondaryKey

secondaryKey

)

[inline]

Returns all values for secondary key.

Parameters:

secondaryKey

Secondary key

Returns:

Values

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

IDictionary<TPrimaryKey, IDictionary<TSecondaryKey, TValue> > Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.ToDictionary

(

)

[inline]

Converts CompositeDictionary to regular dictionary.

Returns:

dictionary

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

---

Property Documentation

template<TPrimaryKey , TSecondaryKey , TValue >

int Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.Count [get, set]

Returns all values count.

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

ICollection<KeyValuePair<TPrimaryKey, KeyValuePair<TSecondaryKey, TValue> > > Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.Entries [get]

Returns all entries.

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

bool Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.IsEmpty [get]

Checks if dictionary is empty.

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

ISet<CompositeKey<TPrimaryKey, TSecondaryKey> > Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.Keys [get]

Returns set of composite keys.

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

ISet<TPrimaryKey> Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.PrimaryKeys [get]

Retunrs set of primary keys.

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

int Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.PrimaryKeysCount [get]

Returns number of primary keys.

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

ISet<TSecondaryKey> Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.SecondaryKeys [get]

Retunrs set of secondary keys.

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

TValue Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.this[CompositeKey< TPrimaryKey, TSecondaryKey > key] [get]

Returns value for composite key.

Parameters:

key	Composite key of primary and secondary key

Returns:

Value

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

template<TPrimaryKey , TSecondaryKey , TValue >

ICollection<TValue> Sharpility.Collections.AbstractCompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.Values [get]

Returns all values.

Implements Sharpility.Collections.CompositeDictionary< TPrimaryKey, TSecondaryKey, TValue >.

---

The documentation for this class was generated from the following file:

• src/Sharpility/Collections/AbstractCompositeDictionary.cs