com.bol.ipresource.etree

Interface IntervalMap<K extends Interval<?>,V>

Type Parameters:

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

V - the type of the values to store.

All Known Implementing Classes:

IpTree, MultiValueIntervalMap, NestedIntervalMap, SynchronizedIntervalMap

public interface IntervalMap<K extends Interval<?>,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).

Method Summary

Modifier and Type	Method and Description
void	clear()
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.
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.

Method Detail

put

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.

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.

Throws:

IllegalArgumentException - if the key or value is null

IntersectingIntervalException - if the key intersects (but is not contained within) an existing key

remove

V remove(K key)

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.

Parameters:

key - key whose mapping is to be removed from the map

Returns:

the value of the removed key

Throws:

IllegalArgumentException - if the specified key is null

remove

void remove(K key,
            V value)

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.

Parameters:

key - key whose mapping is to be removed from the map

value - value with the key to be removed from the map

Throws:

IllegalArgumentException - if the specified key or value is null

clear

void clear()

findFirstLessSpecific

List<V> findFirstLessSpecific(K key)

Finds the value associated with closest interval that contains key but is not equal to key.

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.

findExact

List<V> findExact(K key)

Finds the value associated with key, if it exists.

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

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.

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

findAllLessSpecific

List<V> findAllLessSpecific(K key)

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.

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

List<V> findExactAndAllLessSpecific(K key)

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.

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

findFirstMoreSpecific

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.

The resulting values are ordered from least specific interval to most specific interval.

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

List<V> findAllMoreSpecific(K key)

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.

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

List<V> findExactAndAllMoreSpecific(K key)

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.

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.