RBTreeMap (GATE Core 9.1-SNAPSHOT API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - gate.util.RBTreeMap<K,V>

All Implemented Interfaces:

Serializable, Cloneable, Map<K,V>, SortedMap<K,V>
```
public class RBTreeMap<K,V>
extends AbstractMap<K,V>
implements SortedMap<K,V>, Cloneable, Serializable
```
Slightly modified implementation of java.util.TreeMap in order to return the closest neighbours in the case of a failed search.

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
`RBTreeMap()` Constructs a new, empty map, sorted according to the keys' natural order.
`RBTreeMap(Comparator<? super K> c)` Constructs a new, empty map, sorted according to the given comparator.
`RBTreeMap(Map<? extends K,? extends V> m)` Constructs a new map containing the same mappings as the given map, sorted according to the keys' natural order.
`RBTreeMap(SortedMap<K,? extends V> m)` Constructs a new map containing the same mappings as the given `SortedMap`, sorted according to the same ordering.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all mappings from this RBTreeMap.
`Object`	`clone()` Returns a shallow copy of this `RBTreeMap` instance.
`Comparator<? super K>`	`comparator()` Returns the comparator used to order this map, or `null` if this map uses its keys' natural order.
`boolean`	`containsKey(Object key)` Returns `true` if this map contains a mapping for the specified key.
`boolean`	`containsValue(Object value)` Returns `true` if this map maps one or more keys to the specified value.
`Set<Map.Entry<K,V>>`	`entrySet()` Returns a set view of the mappings contained in this map.
`K`	`firstKey()` Returns the first (lowest) key currently in this sorted map.
`V`	`get(Object key)` Returns the value to which this map maps the specified key.
`V[]`	`getClosestMatch(K key)` Returns a pair of values: (glb,lub).
`V`	`getNextOf(K key)` Returns the value associated to the next key in the map if an exact match doesn't exist.
`SortedMap<K,V>`	`headMap(K toKey)` Returns a view of the portion of this map whose keys are strictly less than `toKey`.
`Set<K>`	`keySet()` Returns a Set view of the keys contained in this map.
`K`	`lastKey()` Returns the last (highest) key currently in this sorted map.
`V`	`put(K key, V value)` Associates the specified value with the specified key in this map.
`void`	`putAll(Map<? extends K,? extends V> map)` Copies all of the mappings from the specified map to this map.
`V`	`remove(Object key)` Removes the mapping for this key from this RBTreeMap if present.
`int`	`size()` Returns the number of key-value mappings in this map.
`SortedMap<K,V>`	`subMap(Object fromKey, Object toKey)` Returns a view of the portion of this map whose keys range from `fromKey`, inclusive, to `toKey`, exclusive.
`SortedMap<K,V>`	`tailMap(K fromKey)` Returns a view of the portion of this map whose keys are greater than or equal to `fromKey`.
`Collection<V>`	`values()` Returns a collection view of the values contained in this map.

Methods inherited from class java.util.AbstractMap
equals, hashCode, isEmpty, toString

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

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

- Constructor Detail
  - RBTreeMap
```
public RBTreeMap()
```
    Constructs a new, empty map, sorted according to the keys' natural order. All keys inserted into the map must implement the Comparable interface. Furthermore, all such keys must be mutually comparable: k1.compareTo(k2) must not throw a ClassCastException for any elements k1 and k2 in the map. If the user attempts to put a key into the map that violates this constraint (for example, the user attempts to put a string key into a map whose keys are integers), the put(Object key, Object value) call will throw a ClassCastException.
    
    See Also:
    
    Comparable
  - RBTreeMap
```
public RBTreeMap(Comparator<? super K> c)
```
    Constructs a new, empty map, sorted according to the given comparator. All keys inserted into the map must be mutually comparable by the given comparator: comparator.compare(k1, k2) must not throw a ClassCastException for any keys k1 and k2 in the map. If the user attempts to put a key into the map that violates this constraint, the put(Object key, Object value) call will throw a ClassCastException.
  - RBTreeMap
```
public RBTreeMap(Map<? extends K,? extends V> m)
```
    Constructs a new map containing the same mappings as the given map, sorted according to the keys' natural order. All keys inserted into the new map must implement the Comparable interface. Furthermore, all such keys must be mutually comparable: k1.compareTo(k2) must not throw a ClassCastException for any elements k1 and k2 in the map. This method runs in n*log(n) time.
    
    Throws:
    
    ClassCastException - the keys in t are not Comparable, or are not mutually comparable.
  - RBTreeMap
```
public RBTreeMap(SortedMap<K,? extends V> m)
```
    Constructs a new map containing the same mappings as the given SortedMap, sorted according to the same ordering. This method runs in linear time.
- Method Detail
  - size
```
public int size()
```
    Returns the number of key-value mappings in this map.
    
    Specified by:
    
    size in interface Map<K,V>
    
    Overrides:
    
    size in class AbstractMap<K,V>
    
    Returns:
    
    the number of key-value mappings in this map.
  - containsKey
```
public boolean containsKey(Object key)
```
    Returns true if this map contains a mapping for the specified key.
    
    Specified by:
    
    containsKey in interface Map<K,V>
    
    Overrides:
    
    containsKey in class AbstractMap<K,V>
    
    Parameters:
    
    key - key whose presence in this map is to be tested.
    
    Returns:
    
    true if this map contains a mapping for the specified key.
    
    Throws:
    
    ClassCastException - if the key cannot be compared with the keys currently in the map.
    
    NullPointerException - key is null and this map uses natural ordering, or its comparator does not tolerate null keys.
  - containsValue
```
public boolean containsValue(Object value)
```
    Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that (value==null ? v==null : value.equals(v)). This operation will probably require time linear in the Map size for most implementations of Map.
    
    Specified by:
    
    containsValue in interface Map<K,V>
    
    Overrides:
    
    containsValue in class AbstractMap<K,V>
    
    Parameters:
    
    value - value whose presence in this Map is to be tested.
    
    Since:
    
    JDK1.2
  - getClosestMatch
```
public V[] getClosestMatch(K key)
```
    Returns a pair of values: (glb,lub). If the given key is found in the map then glb=lub=the value associated with the given key. If the key is not in the map: glb=the value associated with the greatest key in the map that is lower than the given key; or null if the given key is smaller than any key in the map. lub=the value associated with the smaller key in the map that is greater than the given key; or null the given key is greater than any key in the map. If the map is empty it returns (null,null).
  - getNextOf
```
public V getNextOf(K key)
```
    Returns the value associated to the next key in the map if an exact match doesn't exist. If there is an exact match, the method will return the value associated to the given key.
    
    Parameters:
    
    key - the key for wich the look-up will be done.
    
    Returns:
    
    the value associated to the given key or the next available value
  - get
```
public V get(Object key)
```
    Returns the value to which this map maps the specified key. Returns null if the map contains no mapping for this key. A return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.
    
    Specified by:
    
    get in interface Map<K,V>
    
    Overrides:
    
    get in class AbstractMap<K,V>
    
    Parameters:
    
    key - key whose associated value is to be returned.
    
    Returns:
    
    the value to which this map maps the specified key, or null if the map contains no mapping for the key.
    
    Throws:
    
    ClassCastException - key cannot be compared with the keys currently in the map.
    
    NullPointerException - key is null and this map uses natural ordering, or its comparator does not tolerate null keys.
    
    See Also:
    
    containsKey(Object)
  - comparator
```
public Comparator<? super K> comparator()
```
    Returns the comparator used to order this map, or null if this map uses its keys' natural order.
    
    Specified by:
    
    comparator in interface SortedMap<K,V>
    
    Returns:
    
    the comparator associated with this sorted map, or null if it uses its keys' natural sort method.
  - firstKey
```
public K firstKey()
```
    Returns the first (lowest) key currently in this sorted map.
    
    Specified by:
    
    firstKey in interface SortedMap<K,V>
    
    Returns:
    
    the first (lowest) key currently in this sorted map.
    
    Throws:
    
    NoSuchElementException - Map is empty.
  - lastKey
```
public K lastKey()
```
    Returns the last (highest) key currently in this sorted map.
    
    Specified by:
    
    lastKey in interface SortedMap<K,V>
    
    Returns:
    
    the last (highest) key currently in this sorted map.
    
    Throws:
    
    NoSuchElementException - Map is empty.
  - putAll
```
public void putAll(Map<? extends K,? extends V> map)
```
    Copies all of the mappings from the specified map to this map. These mappings replace any mappings that this map had for any of the keys currently in the specified map.
    
    Specified by:
    
    putAll in interface Map<K,V>
    
    Overrides:
    
    putAll in class AbstractMap<K,V>
    
    Parameters:
    
    map - Mappings to be stored in this map.
    
    Throws:
    
    ClassCastException - class of a key or value in the specified map prevents it from being stored in this map.
    
    NullPointerException - this map does not permit null keys and a specified key is null.
  - put
```
public V put(K key,
             V value)
```
    Associates the specified value with the specified key in this map. If the map previously contained a mapping for this key, the old value is replaced.
    
    Specified by:
    
    put in interface Map<K,V>
    
    Overrides:
    
    put in class AbstractMap<K,V>
    
    Parameters:
    
    key - key with which the specified value is to be associated.
    
    value - value to be associated with the specified key.
    
    Returns:
    
    previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key.
    
    Throws:
    
    ClassCastException - key cannot be compared with the keys currently in the map.
    
    NullPointerException - key is null and this map uses natural order, or its comparator does not tolerate null keys.
  - remove
```
public V remove(Object key)
```
    Removes the mapping for this key from this RBTreeMap if present.
    
    Specified by:
    
    remove in interface Map<K,V>
    
    Overrides:
    
    remove in class AbstractMap<K,V>
    
    Returns:
    
    previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key.
    
    Throws:
    
    ClassCastException - key cannot be compared with the keys currently in the map.
    
    NullPointerException - key is null and this map uses natural order, or its comparator does not tolerate null keys.
  - clear
```
public void clear()
```
    Removes all mappings from this RBTreeMap.
    
    Specified by:
    
    clear in interface Map<K,V>
    
    Overrides:
    
    clear in class AbstractMap<K,V>
  - clone
```
public Object clone()
```
    Returns a shallow copy of this RBTreeMap instance. (The keys and values themselves are not cloned.)
    
    Overrides:
    
    clone in class AbstractMap<K,V>
    
    Returns:
    
    a shallow copy of this Map.
  - keySet
```
public Set<K> keySet()
```
    Returns a Set view of the keys contained in this map. The set's iterator will return the keys in ascending order. The map is backed by this RBTreeMap instance, so changes to this map are reflected in the Set, and vice-versa. The Set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.
    
    Specified by:
    
    keySet in interface Map<K,V>
    
    Specified by:
    
    keySet in interface SortedMap<K,V>
    
    Overrides:
    
    keySet in class AbstractMap<K,V>
    
    Returns:
    
    a set view of the keys contained in this RBTreeMap.
  - values
```
public Collection<V> values()
```
    Returns a collection view of the values contained in this map. The collection's iterator will return the values in the order that their corresponding keys appear in the tree. The collection is backed by this RBTreeMap instance, so changes to this map are reflected in the collection, and vice-versa. The collection supports element removal, which removes the corresponding mapping from the map through the Iterator.remove, Collection.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.
    
    Specified by:
    
    values in interface Map<K,V>
    
    Specified by:
    
    values in interface SortedMap<K,V>
    
    Overrides:
    
    values in class AbstractMap<K,V>
    
    Returns:
    
    a collection view of the values contained in this map.
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
    Returns a set view of the mappings contained in this map. The set's iterator returns the mappings in ascending key order. Each element in the returned set is a Map.Entry. The set is backed by this map, so changes to this map are reflected in the set, and vice-versa. The set supports element removal, which removes the corresponding mapping from the RBTreeMap, through the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
    
    Specified by:
    
    entrySet in interface Map<K,V>
    
    Specified by:
    
    entrySet in interface SortedMap<K,V>
    
    Specified by:
    
    entrySet in class AbstractMap<K,V>
    
    Returns:
    
    a set view of the mappings contained in this map.
  - subMap
```
public SortedMap<K,V> subMap(Object fromKey,
                             Object toKey)
```
    Returns a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive. (If fromKey and toKey are equal, the returned sorted map is empty.) The returned sorted map is backed by this map, so changes in the returned sorted map are reflected in this map, and vice-versa. The returned sorted map supports all optional map operations.
    The sorted map returned by this method will throw an IllegalArgumentException if the user attempts to insert a key less than fromKey or greater than or equal to toKey.
    Note: this method always returns a half-open range (which includes its low endpoint but not its high endpoint). If you need a closed range (which includes both endpoints), and the key type allows for calculation of the successor a given key, merely request the subrange from lowEndpoint to successor(highEndpoint). For example, suppose that m is a sorted map whose keys are strings. The following idiom obtains a view containing all of the key-value mappings in m whose keys are between low and high, inclusive:
```
    SortedMap sub = m.submap(low, high+"\0");
```
    A similar technique can be used to generate an open range (which contains neither endpoint). The following idiom obtains a view containing all of the key-value mappings in m whose keys are between low and high, exclusive:
```
    SortedMap sub = m.subMap(low+"\0", high);
```
    Specified by:
    
    subMap in interface SortedMap<K,V>
    
    Parameters:
    
    fromKey - low endpoint (inclusive) of the subMap.
    
    toKey - high endpoint (exclusive) of the subMap.
    
    Returns:
    
    a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive.
    
    Throws:
    
    NullPointerException - if fromKey or toKey is null and this map uses natural order, or its comparator does not tolerate null keys.
    
    IllegalArgumentException - if fromKey is greater than toKey.
  - headMap
```
public SortedMap<K,V> headMap(K toKey)
```
    Returns a view of the portion of this map whose keys are strictly less than toKey. The returned sorted map is backed by this map, so changes in the returned sorted map are reflected in this map, and vice-versa. The returned sorted map supports all optional map operations.
    The sorted map returned by this method will throw an IllegalArgumentException if the user attempts to insert a key greater than or equal to toKey.
    Note: this method always returns a view that does not contain its (high) endpoint. If you need a view that does contain this endpoint, and the key type allows for calculation of the successor a given key, merely request a headMap bounded by successor(highEndpoint). For example, suppose that suppose that m is a sorted map whose keys are strings. The following idiom obtains a view containing all of the key-value mappings in m whose keys are less than or equal to high:
```
     SortedMap head = m.headMap(high+"\0");
 
```
    Specified by:
    
    headMap in interface SortedMap<K,V>
    
    Parameters:
    
    toKey - high endpoint (exclusive) of the headMap.
    
    Returns:
    
    a view of the portion of this map whose keys are strictly less than toKey.
    
    Throws:
    
    NullPointerException - if toKey is null and this map uses natural order, or its comparator does * not tolerate null keys.
  - tailMap
```
public SortedMap<K,V> tailMap(K fromKey)
```
    Returns a view of the portion of this map whose keys are greater than or equal to fromKey. The returned sorted map is backed by this map, so changes in the returned sorted map are reflected in this map, and vice-versa. The returned sorted map supports all optional map operations.
    The sorted map returned by this method will throw an IllegalArgumentException if the user attempts to insert a key less than fromKey.
    Note: this method always returns a view that contains its (low) endpoint. If you need a view that does not contain this endpoint, and the element type allows for calculation of the successor a given value, merely request a tailMap bounded by successor(lowEndpoint). For For example, suppose that suppose that m is a sorted map whose keys are strings. The following idiom obtains a view containing all of the key-value mappings in m whose keys are strictly greater than low:
```
     SortedMap tail = m.tailMap(low+"\0");
 
```
    Specified by:
    
    tailMap in interface SortedMap<K,V>
    
    Parameters:
    
    fromKey - low endpoint (inclusive) of the tailMap.
    
    Returns:
    
    a view of the portion of this map whose keys are greater than or equal to fromKey.
    
    Throws:
    
    NullPointerException - fromKey is null and this map uses natural ordering, or its comparator does not tolerate null keys.

Class RBTreeMap<K,V>

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

RBTreeMap

RBTreeMap

RBTreeMap

RBTreeMap

Method Detail

size

containsKey

containsValue

getClosestMatch

getNextOf

get

comparator

firstKey

lastKey

putAll

put

remove

clear

clone

keySet

values

entrySet

subMap

headMap

tailMap