|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.util.AbstractMap | +--gate.util.RBTreeMap
Slightly modified implementation of java.util.TreeMap in order to return the closest neighbours in the case of a failed search.
Nested Class Summary | |
(package private) static class |
RBTreeMap.Entry
Node in the Tree. |
private class |
RBTreeMap.Iterator
RBTreeMap Iterator. |
private class |
RBTreeMap.SubMap
|
Field Summary | |
private static boolean |
BLACK
|
private Comparator |
comparator
The Comparator used to maintain order in this RBTreeMap, or null if this RBTreeMap uses its elements natural ordering. |
private static boolean |
DEBUG
Debug flag |
private static int |
ENTRIES
|
private Set |
entrySet
|
private static int |
KEYS
|
private Set |
keySet
These fields are initialized to contain an instance of the appropriate view the first time this view is requested. |
private int |
modCount
The number of structural modifications to the tree. |
private static boolean |
RED
|
private RBTreeMap.Entry |
root
|
(package private) static long |
serialVersionUID
Freeze the serialization UID. |
private int |
size
The number of entries in the tree |
private Collection |
values
|
private static int |
VALUES
|
Constructor Summary | |
RBTreeMap()
Constructs a new, empty map, sorted according to the keys' natural order. |
|
RBTreeMap(Comparator c)
Constructs a new, empty map, sorted according to the given comparator. |
|
RBTreeMap(Map m)
Constructs a new map containing the same mappings as the given map, sorted according to the keys' natural order. |
|
RBTreeMap(SortedMap m)
Constructs a new map containing the same mappings as the given SortedMap, sorted according to the same ordering. |
Method Summary | |
(package private) void |
addAllForTreeSet(SortedSet set,
Object defaultVal)
Intended to be called only from TreeSet.addAll |
private static RBTreeMap.Entry |
buildFromSorted(int level,
int lo,
int hi,
int redLevel,
Iterator it,
ObjectInputStream str,
Object defaultVal)
Recursive "helper method" that does the real work of the of the previous method. |
private void |
buildFromSorted(int size,
Iterator it,
ObjectInputStream str,
Object defaultVal)
Linear time tree building algorithm from sorted data. |
void |
clear()
Removes all mappings from this RBTreeMap. |
Object |
clone()
Returns a shallow copy of this RBTreeMap instance. |
private static boolean |
colorOf(RBTreeMap.Entry p)
Balancing operations. |
Comparator |
comparator()
Returns the comparator used to order this map, or null if this map uses its keys' natural order. |
private int |
compare(Object k1,
Object k2)
Compares two keys using the correct comparison method for this RBTreeMap. |
private static int |
computeRedLevel(int sz)
Find the level down to which to assign all nodes BLACK. |
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. |
private void |
decrementSize()
|
private void |
deleteEntry(RBTreeMap.Entry p)
Delete node p, and then rebalance the tree. |
Set |
entrySet()
Returns a set view of the mappings contained in this map. |
private RBTreeMap.Entry |
firstEntry()
Returns the first Entry in the RBTreeMap (according to the RBTreeMap's key-sort function). |
Object |
firstKey()
Returns the first (lowest) key currently in this sorted map. |
private void |
fixAfterDeletion(RBTreeMap.Entry x)
From CLR |
private void |
fixAfterInsertion(RBTreeMap.Entry x)
From CLR |
Object |
get(Object key)
Returns the value to which this map maps the specified key. |
private RBTreeMap.Entry |
getCeilEntry(Object key)
Gets the entry corresponding to the specified key; if no such entry exists, returns the entry for the least key greater than the specified key; if no such entry exists (i.e., the greatest key in the Tree is less than the specified key), returns null. |
Object[] |
getClosestMatch(Object key)
Returns a pair of values: (glb,lub). |
private RBTreeMap.Entry |
getEntry(Object key)
Returns this map's entry for the given key, or null if the map does not contain an entry for the key. |
Object |
getNextOf(Object key)
Returns the value associated to the next key in the map if an exact match doesn't exist. |
private RBTreeMap.Entry |
getPrecedingEntry(Object key)
Returns the entry for the greatest key less than the specified key; if no such entry exists (i.e., the least key in the Tree is greater than the specified key), returns null. |
SortedMap |
headMap(Object toKey)
Returns a view of the portion of this map whose keys are strictly less than toKey. |
private void |
incrementSize()
|
private static Object |
key(RBTreeMap.Entry e)
Returns the key corresonding to the specified Entry. |
Set |
keySet()
Returns a Set view of the keys contained in this map. |
private RBTreeMap.Entry |
lastEntry()
Returns the last Entry in the RBTreeMap (according to the RBTreeMap's key-sort function). |
Object |
lastKey()
Returns the last (highest) key currently in this sorted map. |
private static RBTreeMap.Entry |
leftOf(RBTreeMap.Entry p)
|
private static RBTreeMap.Entry |
parentOf(RBTreeMap.Entry p)
|
Object |
put(Object key,
Object value)
Associates the specified value with the specified key in this map. |
void |
putAll(Map map)
Copies all of the mappings from the specified map to this map. |
private void |
readObject(ObjectInputStream s)
Reconstitute the RBTreeMap instance from a stream (i.e., deserialize it). |
(package private) void |
readTreeSet(int size,
ObjectInputStream s,
Object defaultVal)
Intended to be called only from TreeSet.readObject |
Object |
remove(Object key)
Removes the mapping for this key from this RBTreeMap if present. |
private static RBTreeMap.Entry |
rightOf(RBTreeMap.Entry p)
|
private void |
rotateLeft(RBTreeMap.Entry p)
From CLR |
private void |
rotateRight(RBTreeMap.Entry p)
From CLR |
private static void |
setColor(RBTreeMap.Entry p,
boolean c)
|
int |
size()
Returns the number of key-value mappings in this map. |
SortedMap |
subMap(Object fromKey,
Object toKey)
Returns a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive. |
private RBTreeMap.Entry |
successor(RBTreeMap.Entry t)
Returns the successor of the specified Entry, or null if no such. |
private void |
swapPosition(RBTreeMap.Entry x,
RBTreeMap.Entry y)
Swap the linkages of two nodes in a tree. |
SortedMap |
tailMap(Object fromKey)
Returns a view of the portion of this map whose keys are greater than or equal to fromKey. |
private static boolean |
valEquals(Object o1,
Object o2)
Test two values for equality. |
Collection |
values()
Returns a collection view of the values contained in this map. |
private boolean |
valueSearchNonNull(RBTreeMap.Entry n,
Object value)
|
private boolean |
valueSearchNull(RBTreeMap.Entry n)
|
private void |
writeObject(ObjectOutputStream s)
Save the state of the RBTreeMap instance to a stream (i.e., serialize it). |
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 |
equals, hashCode, isEmpty |
Field Detail |
private static final boolean DEBUG
static final long serialVersionUID
private Comparator comparator
private transient RBTreeMap.Entry root
private transient int size
private transient int modCount
private transient Set keySet
private transient Set entrySet
private transient Collection values
private static final int KEYS
private static final int VALUES
private static final int ENTRIES
private static final boolean RED
private static final boolean BLACK
Constructor Detail |
public RBTreeMap()
Comparable
public RBTreeMap(Comparator c)
public RBTreeMap(Map m)
ClassCastException
- the keys in t are not Comparable, or
are not mutually comparable.public RBTreeMap(SortedMap m)
Method Detail |
private void incrementSize()
private void decrementSize()
public int size()
size
in interface Map
size
in class AbstractMap
public boolean containsKey(Object key)
containsKey
in interface Map
containsKey
in class AbstractMap
key
- key whose presence in this map is to be tested.
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.public boolean containsValue(Object value)
containsValue
in interface Map
containsValue
in class AbstractMap
value
- value whose presence in this Map is to be tested.private boolean valueSearchNull(RBTreeMap.Entry n)
private boolean valueSearchNonNull(RBTreeMap.Entry n, Object value)
public Object[] getClosestMatch(Object key)
public Object getNextOf(Object key)
key
- the key for wich the look-up will be done.
public Object get(Object key)
get
in interface Map
get
in class AbstractMap
key
- key whose associated value is to be returned.
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.containsKey(Object)
public Comparator comparator()
comparator
in interface SortedMap
public Object firstKey()
firstKey
in interface SortedMap
NoSuchElementException
- Map is empty.public Object lastKey()
lastKey
in interface SortedMap
NoSuchElementException
- Map is empty.public void putAll(Map map)
putAll
in interface Map
putAll
in class AbstractMap
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.private RBTreeMap.Entry getEntry(Object key)
ClassCastException
- if the 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.private RBTreeMap.Entry getCeilEntry(Object key)
private RBTreeMap.Entry getPrecedingEntry(Object key)
private static Object key(RBTreeMap.Entry e)
public Object put(Object key, Object value)
put
in interface Map
put
in class AbstractMap
key
- key with which the specified value is to be associated.value
- value to be associated with the specified key.
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.public Object remove(Object key)
remove
in interface Map
remove
in class AbstractMap
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.public void clear()
clear
in interface Map
clear
in class AbstractMap
public Object clone()
clone
in class AbstractMap
public Set keySet()
keySet
in interface Map
keySet
in class AbstractMap
public Collection values()
values
in interface Map
values
in class AbstractMap
public Set entrySet()
entrySet
in interface Map
entrySet
in class AbstractMap
RBTreeMap.Entry
public SortedMap subMap(Object fromKey, Object toKey)
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);
subMap
in interface SortedMap
fromKey
- low endpoint (inclusive) of the subMap.toKey
- high endpoint (exclusive) of the subMap.
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.public SortedMap headMap(Object toKey)
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");
headMap
in interface SortedMap
toKey
- high endpoint (exclusive) of the headMap.
NullPointerException
- if toKey is null and
this map uses natural order, or its comparator does * not
tolerate null keys.public SortedMap tailMap(Object fromKey)
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");
tailMap
in interface SortedMap
fromKey
- low endpoint (inclusive) of the tailMap.
NullPointerException
- fromKey is null and this
map uses natural ordering, or its comparator does
not tolerate null keys.private int compare(Object k1, Object k2)
private static boolean valEquals(Object o1, Object o2)
private RBTreeMap.Entry firstEntry()
private RBTreeMap.Entry lastEntry()
private RBTreeMap.Entry successor(RBTreeMap.Entry t)
private static boolean colorOf(RBTreeMap.Entry p)
private static RBTreeMap.Entry parentOf(RBTreeMap.Entry p)
private static void setColor(RBTreeMap.Entry p, boolean c)
private static RBTreeMap.Entry leftOf(RBTreeMap.Entry p)
private static RBTreeMap.Entry rightOf(RBTreeMap.Entry p)
private void rotateLeft(RBTreeMap.Entry p)
private void rotateRight(RBTreeMap.Entry p)
private void fixAfterInsertion(RBTreeMap.Entry x)
private void deleteEntry(RBTreeMap.Entry p)
private void fixAfterDeletion(RBTreeMap.Entry x)
private void swapPosition(RBTreeMap.Entry x, RBTreeMap.Entry y)
private void writeObject(ObjectOutputStream s) throws IOException
IOException
private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException
IOException
ClassNotFoundException
void readTreeSet(int size, ObjectInputStream s, Object defaultVal) throws IOException, ClassNotFoundException
IOException
ClassNotFoundException
void addAllForTreeSet(SortedSet set, Object defaultVal)
private void buildFromSorted(int size, Iterator it, ObjectInputStream str, Object defaultVal) throws IOException, ClassNotFoundException
size
- the number of keys (or key-value pairs) to be read from
the iterator or stream.it
- If non-null, new entries are created from entries
or keys read from this iterator.defaultVal
- if non-null, this default value is used for
each value in the map. If null, each value is read from
iterator or stream, as described above.
IOException
- propagated from stream reads. This cannot
occur if str is null.
ClassNotFoundException
- propagated from readObject.
This cannot occur if str is null.private static RBTreeMap.Entry buildFromSorted(int level, int lo, int hi, int redLevel, Iterator it, ObjectInputStream str, Object defaultVal) throws IOException, ClassNotFoundException
level
- the current level of tree. Initial call should be 0.lo
- the first element index of this subtree. Initial should be 0.hi
- the last element index of this subtree. Initial should be
size-1.redLevel
- the level at which nodes should be red.
Must be equal to computeRedLevel for tree of this size.
IOException
ClassNotFoundException
private static int computeRedLevel(int sz)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |