Package net.vleo.timel.time

Class IntervalMaps

java.lang.Object

net.vleo.timel.time.IntervalMaps

public final class IntervalMaps
extends Object

Static method class to adapt a NavigableMap into a TimeIterator.

Author:

Andrea Leofreddi

Method Summary

Modifier and Type	Method	Description
static Comparator<Interval>	getIntervalEndComparator()	Retrieve a comparator that will order intervals by end ascending.
static <V> TimeIterator<V>	iterator(NavigableMap<Interval,V> map)	Returns a time iterator for the given map.
static <V> NavigableMap<Interval,V>	of(Sample<V> first, Sample<V>... others)	Retrieves a navigable map initialized with the given values.
static <V> TimeIterator<V>	supremum(NavigableMap<Interval,V> map, Interval interval)	Returns the supremum of interval on given map, that is an iterator that will iterate all map intervals overlapping the given interval parameter.
static <V> TimeIterator<V>	supremumBackward(NavigableMap<Interval,V> map, Interval interval)	Reverse version of the supremum method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getIntervalEndComparator

public static Comparator<Interval> getIntervalEndComparator()

Retrieve a comparator that will order intervals by end ascending.

Returns:

An interval comparator

of

public static <V> NavigableMap<Interval,V> of(Sample<V> first,
                                              Sample<V>... others)

Retrieves a navigable map initialized with the given values.

Type Parameters:

V - Value Java type

Parameters:

first - First sample

others - Rest samples

Returns:

A NavigableMap filled with the given samples

supremum

public static <V> TimeIterator<V> supremum(NavigableMap<Interval,V> map,
                                           Interval interval)

Returns the supremum of interval on given map, that is an iterator that will iterate all map intervals overlapping the given interval parameter. For this method to work properly, it is mandatory that the map is ordered by Interval.end (see #getIntervalEndComparator)

Type Parameters:

V - Value Java type

Parameters:

map - The map to iterate

interval - Interval to use as a reference for the supremum intersection

Returns:

Supremum time iterator

supremumBackward

public static <V> TimeIterator<V> supremumBackward(NavigableMap<Interval,V> map,
                                                   Interval interval)

Reverse version of the supremum method.

Type Parameters:

V - Value Java type

Parameters:

map - The map to iterate

interval - Interval to use as a reference for the supremum intersection

Returns:

The backward supremum time iterator

iterator

public static <V> TimeIterator<V> iterator(NavigableMap<Interval,V> map)

Returns a time iterator for the given map. For this method to work it is mandatory that the map is ordered by Interval.end (see #getIntervalEndComparator)

Type Parameters:

V - Value Java type

Parameters:

map - The map to iterate

Returns:

A time iterator