it.uniroma3.mat.extendedset.utilities

Class CollectionMap<K,I,C extends Collection<I>>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<K,C>

it.uniroma3.mat.extendedset.utilities.CollectionMap<K,I,C>

Type Parameters:

K - key type

I - item type

C - Collection subclass used to collect items

All Implemented Interfaces:

Serializable, Cloneable, Map<K,C>

public class CollectionMap<K,I,C extends Collection<I>>
extends LinkedHashMap<K,C>

This class implements a Map from a key of type K to a collection contains instances of I.

Version:

$Id: CollectionMap.java 152 2011-03-30 11:18:18Z cocciasik $

Author:

Alessandro Colantonio

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
CollectionMap(C emptySet) Initializes the map by providing an instance of the empty collection

Method Summary

Methods

Modifier and Type	Method and Description
CollectionMap<K,I,C>	clone()
boolean	containsItem(I item) Checks if there are some collections that contain the given item
CollectionMap<K,I,C>	empty() Generates an empty CollectionMap instance with the same collection type for values
static void	main(String[] args) Test procedure
void	makeAllCollectionsUnmodifiable() Makes all collections read-only
void	mapValueToKeys(Map<I,K> map) Populates the current instance with the data from another map.
static <KX,IX,CX extends Collection<IX>,EX extends CX> CollectionMap<KX,IX,CX>	newCollectionMap(EX emptySet) Generates a new CollectionMap instance.
C	putAllItems(K key, Collection<? extends I> c) Adds a collection of items to the collection corresponding to the given key
C	putItem(K key, I item) Adds an item to the collection corresponding to the given key
C	removeAllItems(K key, Collection<? extends I> c) Removes a collection of items from the collection corresponding to the given key
C	removeItem(K key, I item) Removes the item from the collection corresponding to the given key

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, get, removeEldestEntry

Methods inherited from class java.util.HashMap

containsKey, entrySet, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

containsKey, entrySet, equals, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

CollectionMap

public CollectionMap(C emptySet)

Initializes the map by providing an instance of the empty collection

Parameters:

emptySet - the empty collection

Method Detail

clone

public CollectionMap<K,I,C> clone()

Overrides:

clone in class HashMap<K,C extends Collection<I>>

empty

public CollectionMap<K,I,C> empty()

Generates an empty CollectionMap instance with the same collection type for values

Returns:

the empty CollectionMap instance

newCollectionMap

public static <KX,IX,CX extends Collection<IX>,EX extends CX> CollectionMap<KX,IX,CX> newCollectionMap(EX emptySet)

Generates a new CollectionMap instance. It is an alternative to the constructor CollectionMap(Collection) that reduces the code to write.

Type Parameters:

KX - key type

IX - item type

CX - Collection subclass used to collect items

EX - empty subset type

Parameters:

emptySet - the empty collection

Returns:

the new instance of CollectionMap

mapValueToKeys

public void mapValueToKeys(Map<I,K> map)

Populates the current instance with the data from another map. In particular, it creates the list of keys associated to each value.

Parameters:

map - the input map

containsItem

public boolean containsItem(I item)

Checks if there are some collections that contain the given item

Parameters:

item - item to check

Returns:

true if the item exists within some collections

putItem

public C putItem(K key,
        I item)

Adds an item to the collection corresponding to the given key

Parameters:

key - the key for the identification of the collection

item - item to add

Returns:

the updated collection of items for the given key

putAllItems

public C putAllItems(K key,
            Collection<? extends I> c)

Adds a collection of items to the collection corresponding to the given key

Parameters:

key - the key for the identification of the collection

c - items to add

Returns:

the updated collection of items for the given key

removeItem

public C removeItem(K key,
           I item)

Removes the item from the collection corresponding to the given key

Parameters:

key - the key for the identification of the collection

item - item to remove

Returns:

the updated collection of items for the given key

removeAllItems

public C removeAllItems(K key,
               Collection<? extends I> c)

Removes a collection of items from the collection corresponding to the given key

Parameters:

key - the key for the identification of the collection

c - items to remove

Returns:

the updated collection of items for the given key

makeAllCollectionsUnmodifiable

public void makeAllCollectionsUnmodifiable()

Makes all collections read-only

main

public static void main(String[] args)

Test procedure

Expected output:

 {}
 {A=[1]}
 {A=[1, 2]}
 {A=[1, 2], B=[3]}
 {A=[1, 2], B=[3, 4, 5, 6]}
 true
 true
 false
 {A=[1], B=[3, 4, 5, 6]}
 {A=[1], B=[3, 4, 5, 6]}
 {A=[1], B=[6]}
 

Parameters:

args -