fr.cnes.sirius.patrius.time

Class IntervalMapSearcher<T>

java.lang.Object

fr.cnes.sirius.patrius.time.IntervalMapSearcher<T>

Type Parameters:

T - The type of the objects

All Implemented Interfaces:

Serializable, Iterable<CacheEntry<AbsoluteDateInterval,T>>

public class IntervalMapSearcher<T>
extends Object
implements Iterable<CacheEntry<AbsoluteDateInterval,T>>, Serializable

This class associates objects to AbsoluteDateInterval. It allows to get efficiently the object corresponding to a given date.

Since:

4.13

Author:

veuillh

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CACHE_SIZE Default cache size.

Constructor Summary

Constructors

Constructor and Description
IntervalMapSearcher(Collection<AbsoluteDateInterval> intervalsCollection, Collection<T> objectsCollection) Simple constructor with a collection of intervals and a collection of objects.
IntervalMapSearcher(Collection<AbsoluteDateInterval> intervalsCollection, Collection<T> objectsCollection, int cacheSize) Simple constructor with a collection of intervals and a collection of objects.
IntervalMapSearcher(Map<AbsoluteDateInterval,T> map) Main constructor.
IntervalMapSearcher(Map<AbsoluteDateInterval,T> map, int cacheSize) Main constructor.

Method Summary

Modifier and Type	Method and Description
boolean	containsData(AbsoluteDate date) Check if the provided date belongs to any available interval.
List<T>	getData() Getter for the data associated to the intervals.
T	getData(AbsoluteDate date) Getter for the object associated to the provided date.
T	getData(AbsoluteDate date, boolean throwException) Getter for the object associated to the provided date.
AbsoluteDateInterval	getFirstInterval() Getter for the first interval.
Map<AbsoluteDateInterval,T>	getIntervalDataAssociation() Getter for the association between intervals and data.
AbsoluteDateIntervalsList	getIntervals() Getter for the available intervals.
AbsoluteDateInterval	getLastInterval() Getter for the last interval.
Iterator<CacheEntry<AbsoluteDateInterval,T>>	iterator() Return an iterator over entries associating an object and an interval.
int	size() Return the number of elements.
CacheEntry<AbsoluteDateInterval,T>[]	toArray() Transform into an array of entries.
CacheEntry<AbsoluteDateInterval,T>[]	toArray(boolean copy) Transform into an array of entries.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DEFAULT_CACHE_SIZE

public static final int DEFAULT_CACHE_SIZE

Default cache size.

See Also:

Constant Field Values

Constructor Detail

IntervalMapSearcher

public IntervalMapSearcher(Collection<AbsoluteDateInterval> intervalsCollection,
                           Collection<T> objectsCollection)

Simple constructor with a collection of intervals and a collection of objects.

Both collections should be the same size and their iterator should coherently go through the data.
The intervals must not overlap with each other.

Parameters:

intervalsCollection - Collection of intervals

objectsCollection - Collection of objects

Throws:

DimensionMismatchException - if intervalsCollection.size() != objectsCollection.size()

IllegalArgumentException - if some intervals from the specified collection overlap with each other if one of the objects of the objects collection is null

IntervalMapSearcher

public IntervalMapSearcher(Collection<AbsoluteDateInterval> intervalsCollection,
                           Collection<T> objectsCollection,
                           int cacheSize)

Simple constructor with a collection of intervals and a collection of objects.

Both collections should be the same size and their iterator should coherently go through the data.
The intervals must not overlap with each other.

Parameters:

intervalsCollection - Collection of intervals

objectsCollection - Collection of objects

cacheSize - Size of the cache

Throws:

DimensionMismatchException - if intervalsCollection.size() != objectsCollection.size()

IllegalArgumentException - if some intervals from the specified collection overlap with each other if one of the objects of the objects collection is null

IntervalMapSearcher

public IntervalMapSearcher(Map<AbsoluteDateInterval,T> map)

Main constructor.

Parameters:

map - Map of intervals and functions. Note that the map is not duplicated internally.

Throws:

IllegalArgumentException - if some intervals from the specified map overlap with each other if one of the objects of the map is null

NullArgumentException - if map is null

IntervalMapSearcher

public IntervalMapSearcher(Map<AbsoluteDateInterval,T> map,
                           int cacheSize)

Main constructor.

Parameters:

map - Map of intervals and functions. Note that the map is not duplicated internally.

cacheSize - Size of the cache

Throws:

IllegalArgumentException - if some intervals from the specified map overlap with each other if one of the objects of the map is null

NullArgumentException - if map is null

Method Detail

containsData

public boolean containsData(AbsoluteDate date)

Check if the provided date belongs to any available interval.

Parameters:

date - Date to check

Returns:

true if the date belongs to an available interval

getFirstInterval

public AbsoluteDateInterval getFirstInterval()

Getter for the first interval.

Returns:

the first interval

getLastInterval

public AbsoluteDateInterval getLastInterval()

Getter for the last interval.

Returns:

the last interval

getIntervals

public AbsoluteDateIntervalsList getIntervals()

Getter for the available intervals.

Returns:

the available intervals

getData

public List<T> getData()

Getter for the data associated to the intervals.

Returns:

the data

getIntervalDataAssociation

public Map<AbsoluteDateInterval,T> getIntervalDataAssociation()

Getter for the association between intervals and data.

Returns:

the interval/data association

getData

public T getData(AbsoluteDate date)

Getter for the object associated to the provided date.

Parameters:

date - Date associated to the object

Returns:

the corresponding object

Throws:

IllegalStateException - if the provided date does not belong to any of the intervals

getData

public T getData(AbsoluteDate date,
                 boolean throwException)

Getter for the object associated to the provided date.

Parameters:

date - Date associated to the object

throwException - Indicate if the method should throw an exception if the provided date does not belong to any of the intervals

Returns:

the corresponding object

Throws:

IllegalStateException - if throwException == true and the provided date does not belong to any of the intervals

iterator

public Iterator<CacheEntry<AbsoluteDateInterval,T>> iterator()

Return an iterator over entries associating an object and an interval.

Specified by:

iterator in interface Iterable<CacheEntry<AbsoluteDateInterval,T>>

Returns:

the iterator

size

public int size()

Return the number of elements.

Returns:

the number of elements

toArray

public CacheEntry<AbsoluteDateInterval,T>[] toArray(boolean copy)

Transform into an array of entries.

Parameters:

copy - Copy the internal array

Returns:

the array of data

toArray

public CacheEntry<AbsoluteDateInterval,T>[] toArray()

Transform into an array of entries.

Returns:

the array of data