com.viaoa.util

Class OADateRangeCache<T>

java.lang.Object

com.viaoa.util.OADateRangeCache<T>

Type Parameters:

T - class type being cached.

public abstract class OADateRangeCache<T>
extends Object

Creates a list of cached objects based on date ranges (begin and end dates).

Usage:

1. Get input dateRange (begin and end date).
2. call findMissingGaps(dateRange), to get any dateRange(s) that are not already in the cache.
3. for each missing gap (maybe 0), get data and then call add()
4. call getCachesItems() with the same dateRange.

Author:

vvia

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OADateRangeCache.DateRange<T>

Constructor Summary

Constructors

Constructor and Description
OADateRangeCache()

Method Summary

Modifier and Type	Method and Description
void	add(OADate beginDate, OADate endDate, List<T> list) Add dateRange with list of objects to the cache.
void	add(OADateRangeCache.DateRange dateRange) Add dateRange with list of objects to the cache.
void	clearCache()
List<OADateRangeCache.DateRange<T>>	findMissingGaps(OADate beginDate, OADate endDate) Used to find missing dateRanges in the cache.
List<OADateRangeCache.DateRange<T>>	findMissingGaps(OADateRangeCache.DateRange dateRange) This is used to find out the missing date range gaps when comparing the cached dateRanged items with a begin and end date range.
List<T>	getCacheItems(OADate beginDate, OADate endDate) Find all of the items in cache for a dateRange.
protected abstract OADate	getDate(T obj) This is used when calling getCacheItems to filter out objects in the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

OADateRangeCache

public OADateRangeCache()

Method Detail

findMissingGaps

public List<OADateRangeCache.DateRange<T>> findMissingGaps(OADateRangeCache.DateRange dateRange)

This is used to find out the missing date range gaps when comparing the cached dateRanged items with a begin and end date range.

Returns:

list of DateRanges that are not in the catch.

findMissingGaps

public List<OADateRangeCache.DateRange<T>> findMissingGaps(OADate beginDate,
                                                           OADate endDate)

Used to find missing dateRanges in the cache.

Returns:

list of dateRanges that are not in the cache.

add

public void add(OADate beginDate,
                OADate endDate,
                List<T> list)

Add dateRange with list of objects to the cache.

add

public void add(OADateRangeCache.DateRange dateRange)

Add dateRange with list of objects to the cache.

getCacheItems

public List<T> getCacheItems(OADate beginDate,
                             OADate endDate)

Find all of the items in cache for a dateRange.

See Also:

to first find and add any missing dateRange gaps.

clearCache

public void clearCache()

getDate

protected abstract OADate getDate(T obj)

This is used when calling getCacheItems to filter out objects in the cache.

Returns:

data value used for this object in the cache.