DefaultCollectionMap (Apache cTAKES 4.0.0 API)

java.lang.Object
- org.apache.ctakes.core.util.collection.DefaultCollectionMap<K,V,T>

All Implemented Interfaces:

Iterable<Map.Entry<K,T>>, Map<K,T>, CollectionMap<K,V,T>
```
public final class DefaultCollectionMap<K,V,T extends Collection<V>>
extends Object
implements CollectionMap<K,V,T>
```
Since:

9/23/2014

Version:

%I%

Author:

SPF , chip-nlp

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

DefaultCollectionMap(Map<K,T> delegate, CollectionCreator<V,T> collectionCreator)

Constructors
Constructor and Description
`DefaultCollectionMap(Map<K,T> delegate, CollectionCreator<V,T> collectionCreator)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<C extends Collection<V>> int`	`addAllValues(K key, C values)` adds everything from the given collection to the internal collection mapped with key
`void`	`clear()`
`void`	`clearCollection(K key)` clearCollection the collection mapped with key
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(K key, V value)` check the collection map for a key and value combination
`boolean`	`containsValue(Object value)`
`Set<Map.Entry<K,T>>`	`entrySet()`
`T`	`get(Object key)`
`Collection<T>`	`getAllCollections()`
`T`	`getCollection(K key)` gets a collection mapped with key.
`T`	`getOrCreateCollection(K key)` obtains a collection mapped with key.
`boolean`	`isEmpty()`
`Iterator<Map.Entry<K,T>>`	`iterator()`
`Set<K>`	`keySet()`
`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
`T`	`put(K key, T value)`
`void`	`putAll(Map<? extends K,? extends T> map)`
`T`	`remove(Object key)`
`void`	`removeValue(K key, V value)` removes value from a collection mapped with key
`int`	`size()`
`Map<K,T>`	`toSimpleMap()` Copy of this object as a simple (java.util.Collection) map of Collection
`Collection<T>`	`values()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - DefaultCollectionMap
```
public DefaultCollectionMap(Map<K,T> delegate,
                            CollectionCreator<V,T> collectionCreator)
```
- Method Detail
  - iterator
```
public Iterator<Map.Entry<K,T>> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Map.Entry<K,T extends Collection<V>>>
  - getAllCollections
```
public Collection<T> getAllCollections()
```
    Specified by:
    
    getAllCollections in interface CollectionMap<K,V,T extends Collection<V>>
    
    Returns:
    
    all of the collections for all keys
  - getCollection
```
public T getCollection(K key)
```
    gets a collection mapped with key. If one does not exist then an empty collection is returned
    
    Specified by:
    
    getCollection in interface CollectionMap<K,V,T extends Collection<V>>
    
    Parameters:
    
    key - key for internal collection
    
    Returns:
    
    collection mapped with key or an empty collection if there is none
  - getOrCreateCollection
```
public T getOrCreateCollection(K key)
```
    obtains a collection mapped with key. If one does not exist then one is added to this CollectionMap
    
    Specified by:
    
    getOrCreateCollection in interface CollectionMap<K,V,T extends Collection<V>>
    
    Parameters:
    
    key - key for internal collection
    
    Returns:
    
    (possibly new) collection mapped with key
  - containsValue
```
public boolean containsValue(K key,
                             V value)
```
    check the collection map for a key and value combination
    
    Specified by:
    
    containsValue in interface CollectionMap<K,V,T extends Collection<V>>
    
    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
```
public boolean placeValue(K key,
                          V value)
```
    places value into a collection mapped with key
    
    Specified by:
    
    placeValue in interface CollectionMap<K,V,T extends Collection<V>>
    
    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
```
public boolean placeMap(Map<K,V> map)
```
    places each value of a map into a collection mapped with the appropriate key
    
    Specified by:
    
    placeMap in interface CollectionMap<K,V,T extends Collection<V>>
    
    Parameters:
    
    map - map to store
    
    Returns:
    
    true if this set did not already contain the value
  - removeValue
```
public void removeValue(K key,
                        V value)
```
    removes value from a collection mapped with key
    
    Specified by:
    
    removeValue in interface CollectionMap<K,V,T extends Collection<V>>
    
    Parameters:
    
    key - key for internal collection
    
    value - value to remove from internal collection
  - addAllValues
```
public <C extends Collection<V>> int addAllValues(K key,
                                                  C values)
```
    adds everything from the given collection to the internal collection mapped with key
    
    Specified by:
    
    addAllValues in interface CollectionMap<K,V,T extends Collection<V>>
    
    Parameters:
    
    key - key for internal collection
    
    values - collection of values to place in internal collection
    
    Returns:
    
    the number of new items added
  - clearCollection
```
public void clearCollection(K key)
```
    clearCollection the collection mapped with key
    
    Specified by:
    
    clearCollection in interface CollectionMap<K,V,T extends Collection<V>>
    
    Parameters:
    
    key - key for internal collection
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<K,T extends Collection<V>>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<K,T extends Collection<V>>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<K,T extends Collection<V>>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<K,T extends Collection<V>>
  - get
```
public T get(Object key)
```
    Specified by:
    
    get in interface Map<K,T extends Collection<V>>
  - put
```
public T put(K key,
             T value)
```
    Specified by:
    
    put in interface Map<K,T extends Collection<V>>
  - remove
```
public T remove(Object key)
```
    Specified by:
    
    remove in interface Map<K,T extends Collection<V>>
  - putAll
```
public void putAll(Map<? extends K,? extends T> map)
```
    Specified by:
    
    putAll in interface Map<K,T extends Collection<V>>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<K,T extends Collection<V>>
  - keySet
```
public Set<K> keySet()
```
    Specified by:
    
    keySet in interface Map<K,T extends Collection<V>>
  - values
```
public Collection<T> values()
```
    Specified by:
    
    values in interface Map<K,T extends Collection<V>>
  - entrySet
```
public Set<Map.Entry<K,T>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<K,T extends Collection<V>>
  - toSimpleMap
```
public Map<K,T> toSimpleMap()
```
    Copy of this object as a simple (java.util.Collection) map of Collection
    
    Specified by:
    
    toSimpleMap in interface CollectionMap<K,V,T extends Collection<V>>
    
    Returns:
    
    map of java.util.Collection

Class DefaultCollectionMap<K,V,T extends Collection<V>>

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Methods inherited from interface java.lang.Iterable

Constructor Detail

DefaultCollectionMap

Method Detail

iterator

getAllCollections

getCollection

getOrCreateCollection

containsValue

placeValue

placeMap

removeValue

addAllValues

clearCollection

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet

toSimpleMap