org.apache.ctakes.core.util.collection

Interface CollectionMap<K,V,T extends Collection<V>>

All Superinterfaces:

Iterable<Map.Entry<K,T>>, Map<K,T>

All Known Implementing Classes:

ArrayListMap, DefaultCollectionMap, EnumSetMap, HashSetMap, ImmutableCollectionMap

public interface CollectionMap<K,V,T extends Collection<V>>
extends Map<K,T>, Iterable<Map.Entry<K,T>>

Author: SPF Affiliation: CHIP-NLP Date: 6/24/14

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
<C extends Collection<V>> int	addAllValues(K key, C collection) adds everything from the given collection to the internal collection mapped with key
void	clearCollection(K key) clearCollection the collection mapped with key
boolean	containsValue(K key, V value) check the collection map for a key and value combination
Collection<T>	getAllCollections()
T	getCollection(K key) gets a collection mapped with key.
T	getOrCreateCollection(K key) obtains a collection mapped with key.
boolean	placeMap(Map<K,V> map) places each value of a map into a collection mapped with the appropriate key
boolean	placeValue(K key, V value) places value into a collection mapped with key
void	removeValue(K key, V value) removes value from a collection mapped with key
Map<K,T>	toSimpleMap() Copy of this object as a simple (java.util.Collection) map of Collection

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getAllCollections

Collection<T> getAllCollections()

Returns:

all of the collections for all keys

getCollection

T getCollection(K key)

gets a collection mapped with key. If one does not exist then an empty collection is returned

Parameters:

key - key for internal collection

Returns:

collection mapped with key or an empty collection if there is none

getOrCreateCollection

T getOrCreateCollection(K key)

obtains a collection mapped with key. If one does not exist then one is added to this CollectionMap

Parameters:

key - key for internal collection

Returns:

(possibly new) collection mapped with key

containsValue

boolean containsValue(K key,
                      V value)

check the collection map for a key and value combination

Parameters:

key - key for internal collection

value - value to check in internal collection

Returns:

true if this CollectionMap contain the value for the given key

placeValue

boolean placeValue(K key,
                   V value)

places value into a collection mapped with key

Parameters:

key - key for internal collection

value - value to placeValue in internal collection

Returns:

true if this set did not already contain the value

placeMap

boolean placeMap(Map<K,V> map)

places each value of a map into a collection mapped with the appropriate key

Parameters:

map - map to store

Returns:

true if this set did not already contain the value

removeValue

void removeValue(K key,
                 V value)

removes value from a collection mapped with key

Parameters:

key - key for internal collection

value - value to remove from internal collection

addAllValues

<C extends Collection<V>> int addAllValues(K key,
                                           C collection)

adds everything from the given collection to the internal collection mapped with key

Parameters:

key - key for internal collection

collection - collection of values to place in internal collection

Returns:

the number of new items added

clearCollection

void clearCollection(K key)

clearCollection the collection mapped with key

Parameters:

key - key for internal collection

toSimpleMap

Map<K,T> toSimpleMap()

Copy of this object as a simple (java.util.Collection) map of Collection

Returns:

map of java.util.Collection