NestedIntervalMap (ip-resource 1.4.7 API)

java.lang.Object
- com.bol.ipresource.etree.NestedIntervalMap<K,V>

Type Parameters:

K - the type of the interval (must implement Interval).

V - the type of the values to store.

All Implemented Interfaces:

IntervalMap<K,V>
```
public final class NestedIntervalMap<K extends Interval<K>,V>
extends Object
implements IntervalMap<K,V>
```
A map with intervals as keys. Intervals are only allowed to intersect if they are fully contained in the other interval (in other words, siblings are not allowed to intersect, but nesting is ok).
Note that this implementation is not synchronized. If multiple threads access a map concurrently, and at least one of the threads modifies the map structurally, it must be synchronized externally. (A structural modification is any operation that adds or deletes one or more mappings; merely changing the value associated with an existing key is not a structural modification.) This is typically accomplished by synchronizing on some object that naturally encapsulates the map.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NestedIntervalMap.Key<K extends Interval<K>>

Nested Classes
Modifier and Type	Class and Description
`static class`	`NestedIntervalMap.Key<K extends Interval<K>>`

Constructor Summary

Constructors
Constructor and Description
`NestedIntervalMap()` Construct an empty `NestedIntervalMap`.
`NestedIntervalMap(NestedIntervalMap<K,V> source)` Construct a new `NestedIntervalMap` with (key, values) of `source` copied.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears all values from the map.
`boolean`	`equals(Object obj)`
`List<V>`	`findAllLessSpecific(K key)` Finds all values that are associated to intervals that contain `key` but are not equal to `key`.
`List<V>`	`findAllMoreSpecific(K key)` Finds all values associated with intervals that are contained within (more specific than) `key`, but not equal to `key`.
`List<V>`	`findExact(K key)` Finds the value associated with `key`, if it exists.
`List<V>`	`findExactAndAllLessSpecific(K key)` Finds all values that are associated to intervals that contain `key`.
`List<V>`	`findExactAndAllMoreSpecific(K key)` Finds all values associated with intervals that are equal to `key` or contained within (more specific than) `key`.
`List<V>`	`findExactOrFirstLessSpecific(K key)` Finds the value associated with `key`, or its closest enclosing if `key` is not contained in this map, if it exists.
`List<V>`	`findFirstLessSpecific(K key)` Finds the value associated with closest interval that contains `key` but is not equal to `key`.
`List<V>`	`findFirstMoreSpecific(K key)` Finds all values associated with intervals that are more specific (contained in) `key`, but excluding the values that are nested inside the matching intervals.
`int`	`hashCode()`
`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 the key, the old value is replaced by the specified value.
`V`	`remove(K key)` Removes the mapping for a key from this map if it is present.
`void`	`remove(K key, V value)` Removes the mapping for a key and value from this map if both are present.
`String`	`toString()`

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

- Constructor Detail
  - NestedIntervalMap
```
public NestedIntervalMap()
```
    Construct an empty NestedIntervalMap.
  - NestedIntervalMap
```
public NestedIntervalMap(NestedIntervalMap<K,V> source)
```
    Construct a new NestedIntervalMap with (key, values) of source copied.
    
    Parameters:
    
    source - the source to copy.
- Method Detail
  - put
```
public V put(K key,
             V value)
```
    Description copied from interface: IntervalMap
    
    Associates the specified value with the specified key in this map If the map previously contained a mapping for the key, the old value is replaced by the specified value.
    
    Specified by:
    
    put in interface IntervalMap<K extends Interval<K>,V>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    value - value to be associated with the specified key
    
    Returns:
    
    the replaced value, if applies. null otherwise.
  - remove
```
public V remove(K key)
```
    Description copied from interface: IntervalMap
    
    Removes the mapping for a key from this map if it is present.
    
    The map will not contain a mapping for the specified key once the call returns.
    
    Specified by:
    
    remove in interface IntervalMap<K extends Interval<K>,V>
    
    Parameters:
    
    key - key whose mapping is to be removed from the map
    
    Returns:
    
    the value of the removed key
  - remove
```
public void remove(K key,
                   V value)
```
    Description copied from interface: IntervalMap
    
    Removes the mapping for a key and value from this map if both are present.
    
    The map will not contain a mapping for the specified key with the specified value once the call returns.
    
    Specified by:
    
    remove in interface IntervalMap<K extends Interval<K>,V>
    
    Parameters:
    
    key - key whose mapping is to be removed from the map
    
    value - value with the key to be removed from the map
  - findFirstLessSpecific
```
public List<V> findFirstLessSpecific(K key)
```
    Description copied from interface: IntervalMap
    
    Finds the value associated with closest interval that contains key but is not equal to key.
    
    Specified by:
    
    findFirstLessSpecific in interface IntervalMap<K extends Interval<K>,V>
    
    Parameters:
    
    key - the key to find the closest enclosing interval for
    
    Returns:
    
    the value associated with the closest enclosing interval of key, or an empty list if no such mapping exists.
  - findAllLessSpecific
```
public List<V> findAllLessSpecific(K key)
```
    Description copied from interface: IntervalMap
    
    Finds all values that are associated to intervals that contain key but are not equal to key.
    
    The resulting values are ordered from least specific interval to most specific interval.
    
    Specified by:
    
    findAllLessSpecific in interface IntervalMap<K extends Interval<K>,V>
    
    Parameters:
    
    key - the key to find all containing intervals for
    
    Returns:
    
    the (possibly empty) list of values that are associated to intervals that contain key but is not equal to key.
  - findExactAndAllLessSpecific
```
public List<V> findExactAndAllLessSpecific(K key)
```
    Description copied from interface: IntervalMap
    
    Finds all values that are associated to intervals that contain key.
    
    The resulting values are ordered from least specific interval to most specific interval. So if a mapping for key exists the last element of the returned list will contain the value associated with key.
    
    Specified by:
    
    findExactAndAllLessSpecific in interface IntervalMap<K extends Interval<K>,V>
    
    Parameters:
    
    key - the key to find all containing intervals for
    
    Returns:
    
    the (possibly empty) list of values that are associated to intervals that contain key
  - findExact
```
public List<V> findExact(K key)
```
    Description copied from interface: IntervalMap
    
    Finds the value associated with key, if it exists.
    
    Specified by:
    
    findExact in interface IntervalMap<K extends Interval<K>,V>
    
    Parameters:
    
    key - the key to find the mapping for
    
    Returns:
    
    the value associated with key or an empty list if no such value exists
  - findExactOrFirstLessSpecific
```
public List<V> findExactOrFirstLessSpecific(K key)
```
    Description copied from interface: IntervalMap
    
    Finds the value associated with key, or its closest enclosing if key is not contained in this map, if it exists.
    
    Specified by:
    
    findExactOrFirstLessSpecific in interface IntervalMap<K extends Interval<K>,V>
    
    Parameters:
    
    key - the key to find the mapping for
    
    Returns:
    
    the value associated with key or its closest containing interval, or an empty list if no such value exists
  - findFirstMoreSpecific
```
public List<V> findFirstMoreSpecific(K key)
```
    Description copied from interface: IntervalMap
    
    Finds all values associated with intervals that are more specific (contained in) key, but excluding the values that are nested inside the matching intervals.
    
    The resulting values are ordered from least specific interval to most specific interval.
    
    Specified by:
    
    findFirstMoreSpecific in interface IntervalMap<K extends Interval<K>,V>
    
    Parameters:
    
    key - the key to find the first level more specific values for
    
    Returns:
    
    the (possibly empty) list of values associated with the matching intervals.
  - findAllMoreSpecific
```
public List<V> findAllMoreSpecific(K key)
```
    Description copied from interface: IntervalMap
    
    Finds all values associated with intervals that are contained within (more specific than) key, but not equal to key.
    
    The resulting values are ordered from least specific interval to most specific interval.
    
    Specified by:
    
    findAllMoreSpecific in interface IntervalMap<K extends Interval<K>,V>
    
    Parameters:
    
    key - the key to find all levels more specific values for
    
    Returns:
    
    the (possibly empty) list of values associated with the matching intervals.
  - findExactAndAllMoreSpecific
```
public List<V> findExactAndAllMoreSpecific(K key)
```
    Description copied from interface: IntervalMap
    
    Finds all values associated with intervals that are equal to key or contained within (more specific than) key.
    
    The resulting values are ordered from least specific interval to most specific interval. So if a mapping for key exists the first element of the returned list will contain the value associated with key.
    
    Specified by:
    
    findExactAndAllMoreSpecific in interface IntervalMap<K extends Interval<K>,V>
    
    Parameters:
    
    key - the key to find the exact and all levels more specific values for
    
    Returns:
    
    the (possibly empty) list of values associated with the matching intervals.
  - clear
```
public void clear()
```
    Clears all values from the map.
    
    Specified by:
    
    clear in interface IntervalMap<K extends Interval<K>,V>
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class NestedIntervalMap<K extends Interval<K>,V>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NestedIntervalMap

NestedIntervalMap

Method Detail

put

remove

remove

findFirstLessSpecific

findAllLessSpecific

findExactAndAllLessSpecific

findExact

findExactOrFirstLessSpecific

findFirstMoreSpecific

findAllMoreSpecific

findExactAndAllMoreSpecific

clear

equals

hashCode

toString