TreeMultiMap (S-Space Package 2.0.1 API)

java.lang.Object
- edu.ucla.sspace.util.TreeMultiMap<K,V>

All Implemented Interfaces:

MultiMap<K,V>, SortedMultiMap<K,V>, Serializable

Direct Known Subclasses:

BoundedSortedMultiMap
```
public class TreeMultiMap<K,V>
extends Object
implements SortedMultiMap<K,V>, Serializable
```
A Red-Black tree SortedMultiMap implementation. Map elements are sorted according to the natural ordering of the keys, or by a Comparator provided to the constructor.
This implementation provides guaranteed log(n) time cost for the containsKey, get, put and remove operations. The remaining operations run in constant time. The only exception is the range method, which runs in constant time except for the first time it is invoked on any sub-map returned by headMap, tailMap, or subMap, when it runs in linear time.
This map is not thread-safe.

See Also:
Map, SortedMap, HashMultiMap, MultiMap, Serialized Form

Constructor Summary

Constructors
Constructor and Description
`TreeMultiMap()` Constructs this map using the natural ordering of the keys.
`TreeMultiMap(Comparator<? super K> c)` Constructs this map where keys will be sorted according to the provided comparator.
`TreeMultiMap(Map<? extends K,? extends V> m)` Constructs this map using the natural ordering of the keys, adding all of the provided mappings to this map.

Method Summary

Methods
Modifier and Type	Method and Description
`Map<K,Set<V>>`	`asMap()` Returns a `Map`-based view of this `MultiMap`
`void`	`clear()` Removes all of the mappings from this multi-map.
`Comparator<? super K>`	`comparator()` Returns the comparator used to order the keys in this map, or null if this map uses the `natural ordering` of its keys.
`boolean`	`containsKey(Object key)` Returns `true` if this multi-map contains a mapping for the specified key.
`boolean`	`containsMapping(Object key, Object value)` Returns `true` if this multi-map contains a mapping from specified key to the specified value.
`boolean`	`containsValue(Object value)` Returns `true` if this multi-map contains from any key to the specified value.
`Set<Map.Entry<K,V>>`	`entrySet()` Returns a `Set` view of all the key-value mappings contained in this multi-map.
`K`	`firstKey()` Returns a `Set` view of the mappings contained in this map.
`Set<V>`	`get(Object key)` Returns the set of values mapped to this key or `null` of the key is not mapped to any values
`SortedMultiMap<K,V>`	`headMap(K toKey)` Returns a view of the portion of this map whose keys are less than `toKey`.
`boolean`	`isEmpty()` Returns `true` if this multi-map contains no mappings.
`Set<K>`	`keySet()` Returns a `Set` view of the mappings contained in this multi-map.
`K`	`lastKey()` Returns the last (highest) key currently in this map.
`boolean`	`put(K key, V value)` Adds the specified value to the set of values associated with the specified key in this map.
`void`	`putAll(Map<? extends K,? extends V> m)` Copies all of the mappings from the specified map to this mutli-map
`void`	`putAll(MultiMap<? extends K,? extends V> m)` Copies all of the mappings from the specified mulit-map to this mutli-map
`boolean`	`putMany(K key, Collection<V> values)` Adds all of the specified values to the set of values associated with the specified key in this map.
`int`	`range()` Returns the number of values maped to keys.
`Set<V>`	`remove(Object key)` Removes the mapping for a key from this multi-map if it is present, returning any mapped values to that key
`boolean`	`remove(Object key, Object value)` Removes the specified mapping for a key if it is present.
`int`	`size()` Returns the number of keys that are mapped to one or more values in this multi-map.
`SortedMultiMap<K,V>`	`subMap(K fromKey, K toKey)` Returns a view of the portion of this map whose keys range from `fromKey`, inclusive, to `toKey`, exclusive.
`SortedMultiMap<K,V>`	`tailMap(K fromKey)` Returns a view of the portion of this map whose keys are greater than or equal to `fromKey`.
`String`	`toString()` Returns the string form of this multi-map
`Collection<V>`	`values()` Returns a `Collection` view of the values contained in this map.
`Collection<Set<V>>`	`valueSets()` Returns a `Collection` view of the sets of values mapped to each key in this map.

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

- Constructor Detail
  - TreeMultiMap
```
public TreeMultiMap()
```
    Constructs this map using the natural ordering of the keys.
  - TreeMultiMap
```
public TreeMultiMap(Comparator<? super K> c)
```
    Constructs this map where keys will be sorted according to the provided comparator.
  - TreeMultiMap
```
public TreeMultiMap(Map<? extends K,? extends V> m)
```
    Constructs this map using the natural ordering of the keys, adding all of the provided mappings to this map.
- Method Detail
  - asMap
```
public Map<K,Set<V>> asMap()
```
    Returns a Map-based view of this MultiMap
    
    Specified by:
    
    asMap in interface MultiMap<K,V>
  - clear
```
public void clear()
```
    Removes all of the mappings from this multi-map.
    
    Specified by:
    
    clear in interface MultiMap<K,V>
  - comparator
```
public Comparator<? super K> comparator()
```
    Returns the comparator used to order the keys in this map, or null if this map uses the natural ordering of its keys.
    
    Specified by:
    
    comparator in interface SortedMultiMap<K,V>
  - containsKey
```
public boolean containsKey(Object key)
```
    Returns true if this multi-map contains a mapping for the specified key.
    
    Specified by:
    
    containsKey in interface MultiMap<K,V>
  - containsMapping
```
public boolean containsMapping(Object key,
                      Object value)
```
    Returns true if this multi-map contains a mapping from specified key to the specified value.
    
    Specified by:
    
    containsMapping in interface MultiMap<K,V>
  - containsValue
```
public boolean containsValue(Object value)
```
    Returns true if this multi-map contains from any key to the specified value.
    
    Specified by:
    
    containsValue in interface MultiMap<K,V>
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
    Returns a Set view of all the key-value mappings contained in this multi-map.
    
    Specified by:
    
    entrySet in interface MultiMap<K,V>
  - firstKey
```
public K firstKey()
```
    Returns a Set view of the mappings contained in this map.
    
    Specified by:
    
    firstKey in interface SortedMultiMap<K,V>
  - get
```
public Set<V> get(Object key)
```
    Returns the set of values mapped to this key or null of the key is not mapped to any values
    
    Specified by:
    
    get in interface MultiMap<K,V>
  - headMap
```
public SortedMultiMap<K,V> headMap(K toKey)
```
    Returns a view of the portion of this map whose keys are less than toKey.
    
    Specified by:
    
    headMap in interface SortedMultiMap<K,V>
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this multi-map contains no mappings.
    
    Specified by:
    
    isEmpty in interface MultiMap<K,V>
  - keySet
```
public Set<K> keySet()
```
    Returns a Set view of the mappings contained in this multi-map.
    
    Specified by:
    
    keySet in interface MultiMap<K,V>
  - lastKey
```
public K lastKey()
```
    Returns the last (highest) key currently in this map.
    
    Specified by:
    
    lastKey in interface SortedMultiMap<K,V>
  - put
```
public boolean put(K key,
          V value)
```
    Adds the specified value to the set of values associated with the specified key in this map.
    
    Specified by:
    
    put in interface MultiMap<K,V>
    
    Parameters:
    key - key with which the specified value is to be associated
    value - a value to be associated with the specified key
    
    Returns:
    true if the provided value was not already in the set of value mapped to the specified key
  - putAll
```
public void putAll(Map<? extends K,? extends V> m)
```
    Copies all of the mappings from the specified map to this mutli-map
    
    Specified by:
    
    putAll in interface MultiMap<K,V>
  - putAll
```
public void putAll(MultiMap<? extends K,? extends V> m)
```
    Copies all of the mappings from the specified mulit-map to this mutli-map
    
    Specified by:
    
    putAll in interface MultiMap<K,V>
  - putMany
```
public boolean putMany(K key,
              Collection<V> values)
```
    Adds all of the specified values to the set of values associated with the specified key in this map.
    
    Specified by:
    
    putMany in interface MultiMap<K,V>
    
    Parameters:
    key - key with which the specified value is to be associated
    values - a collection of values to be associated with the specified key
    
    Returns:
    true if at least one of the provided value was not already in the set of value mapped to the specified key
  - range
```
public int range()
```
    Returns the number of values maped to keys. Note that in the bijective case, this will equal the value returned by MultiMap.size(). However, in the case where a key is mapped to more than one value, this method will always return a value strictly larger than size(). This method runs in constant time, except for the first time called on a sub-map, when it runs in linear time to the number of values.
    
    Specified by:
    
    range in interface MultiMap<K,V>
    
    Returns:
    the number of values maped to keys
  - remove
```
public Set<V> remove(Object key)
```
    Removes the mapping for a key from this multi-map if it is present, returning any mapped values to that key
    
    Specified by:
    
    remove in interface MultiMap<K,V>
    
    Returns:
    the set of values mapped to the key or the empty set if the key was not present
  - remove
```
public boolean remove(Object key,
             Object value)
```
    Removes the specified mapping for a key if it is present. If the key is mapped to other values, it is retained, otherwise the key is removed from the map. This method provides a way to remove a specific mapping for a key without removing all other existing mappings.
    
    Specified by:
    
    remove in interface MultiMap<K,V>
    
    Returns:
    true if the specified mapping was removed
  - size
```
public int size()
```
    Returns the number of keys that are mapped to one or more values in this multi-map.
    
    Specified by:
    
    size in interface MultiMap<K,V>
    
    See Also:
    MultiMap.range()
  - subMap
```
public SortedMultiMap<K,V> subMap(K fromKey,
                         K toKey)
```
    Returns a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive.
    
    Specified by:
    
    subMap in interface SortedMultiMap<K,V>
  - tailMap
```
public SortedMultiMap<K,V> tailMap(K fromKey)
```
    Returns a view of the portion of this map whose keys are greater than or equal to fromKey.
    
    Specified by:
    
    tailMap in interface SortedMultiMap<K,V>
  - toString
```
public String toString()
```
    Returns the string form of this multi-map
    
    Overrides:
    
    toString in class Object
  - values
```
public Collection<V> values()
```
    Returns a Collection view of the values contained in this map. The collection and its Iterator are backed by the map, so changes to the map are reflected in the collection, and vice-versa.
    
    Specified by:
    
    values in interface MultiMap<K,V>
  - valueSets
```
public Collection<Set<V>> valueSets()
```
    Returns a Collection view of the sets of values mapped to each key in this map.
    
    Specified by:
    
    valueSets in interface MultiMap<K,V>

Class TreeMultiMap<K,V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TreeMultiMap

TreeMultiMap

TreeMultiMap

Method Detail

asMap

clear

comparator

containsKey

containsMapping

containsValue

entrySet

firstKey

get

headMap

isEmpty

keySet

lastKey

put

putAll

putAll

putMany

range

remove

remove

size

subMap

tailMap

toString

values

valueSets