sos.dated.util
Class ArrayListByDate

java.lang.Object
  |
  +--sos.dated.util.AbstractDatedObject
        |
        +--sos.dated.util.AbstractDatedCollection
              |
              +--sos.dated.util.AbstractDatedList
                    |
                    +--sos.dated.util.AbstractListByDate
                          |
                          +--sos.dated.util.ArrayListByDate

All Implemented Interfaces:

java.lang.Cloneable, DatedCollection, DatedList, DatedObject, java.util.RandomAccess, java.io.Serializable

public class ArrayListByDate

extends sos.dated.util.AbstractListByDate

implements DatedList, java.io.Serializable, java.lang.Cloneable, java.util.RandomAccess

An implementation of DatedList that can efficiently iterate through the list of elements at a given date by maintaining a java.util.ArrayList at each date.

This implementation is serializable and cloneable; however, it is not synchronized. To use it safely in a multi-threaded situation, wrap an instance of the dated list with a call to DatedCollections.synchronizedDatedList.

Since:

1.0

See Also:

ArrayListByElement, DatedList, DatedCollections.synchronizedDatedList(DatedList)

Field Summary

Fields inherited from interface sos.dated.util.DatedObject

MAX_DATE, MIN_DATE

Constructor Summary

ArrayListByDate()
Creates a new instance of ArrayListByDate.

ArrayListByDate(DatedCollection datedCollection)
Creates a new instance of ArrayListByDate initialized with the elements of datedCollection.

Method Summary

void	add(int index, java.lang.Object value, java.util.Date from, java.util.Date to) Inserts an element into the list for a specified date range (optional operation).
Dates	add(java.lang.Object value, java.util.Date from, java.util.Date to) Adds an instance of the specified element to this collection for the specified date range (optional operation).
void	clear(java.util.Date from, java.util.Date to) Removes all elements from this dated collection for the specified dates (optional operation).
java.lang.Object	clone() Creates and returns a copy of this object.
protected java.util.List	copyList(java.util.List list)
protected java.util.List	createList()
DateIterator	dateIterator(java.util.Date date) Returns an iterator of the date ranges of when this dated object has changed, starting at the range that contains the specified date.
java.lang.Object	get(int index, java.util.Date date) Retrieves the element at the specified position on the specified date.
DatedValue	remove(int index, java.util.Date from, java.util.Date to) Removes from this list the element at the specified position for the specified date range (optional operation).
DatedValue	set(int index, java.lang.Object value, java.util.Date from, java.util.Date to) Replaces the element at the specified position with the specified element for the specified date range.
int	size(java.util.Date date) Returns the number of elements in this collection at the specified date.

Methods inherited from class sos.dated.util.AbstractDatedList

addAll, checkForComodification, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, modCount, removeRange, subList, upModCount

Methods inherited from class sos.dated.util.AbstractDatedCollection

addAll, contains, containsAll, containsThroughout, excludesThroughout, hasSizeThroughout, isEmpty, isEmptyThroughout, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class sos.dated.util.AbstractDatedObject

dateIterator, equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface sos.dated.util.DatedList

add, addAll, equals, get, hashCode, indexOf, lastIndexOf, listIterator, listIterator, remove, set, subList

Methods inherited from interface sos.dated.util.DatedCollection

add, addAll, clear, contains, containsAll, containsThroughout, excludesThroughout, hasSizeThroughout, isEmpty, isEmptyThroughout, iterator, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface sos.dated.util.DatedObject

dateIterator, dateIterator, equals, hashCode, toString

Constructor Detail

ArrayListByDate

public ArrayListByDate()

Creates a new instance of ArrayListByDate.

ArrayListByDate

public ArrayListByDate(DatedCollection datedCollection)

Creates a new instance of ArrayListByDate initialized with the elements of datedCollection.

Parameters:

datedCollection - collection with which to initialize the new ArrayListByDate

Throws:

java.lang.NullPointerException - if datedCollection is null

Method Detail

clone

public java.lang.Object clone()

Description copied from class: AbstractDatedList

Creates and returns a copy of this object. Subclasses that wish to be cloneable should override this method but first call their parent's clone method.

Overrides:

clone in class sos.dated.util.AbstractListByDate

Returns:

a copy of this dated list

createList

protected java.util.List createList()

Specified by:

createList in class sos.dated.util.AbstractListByDate

copyList

protected java.util.List copyList(java.util.List list)

Overrides:

copyList in class sos.dated.util.AbstractListByDate

add

public Dates add(java.lang.Object value,
                 java.util.Date from,
                 java.util.Date to)

Adds an instance of the specified element to this collection for the specified date range (optional operation).

Specified by:

add in interface DatedCollection

Overrides:

add in class AbstractDatedList

Parameters:

value - element to add

from - starting date at which the element should be added

to - ending date at which the element should be added

Returns:

a series of date ranges indicating when the addition changed this collection

Throws:

java.lang.NullPointerException - if from or to is null

java.lang.UnsupportedOperationException - if this collection does not support add

add

public void add(int index,
                java.lang.Object value,
                java.util.Date from,
                java.util.Date to)

Description copied from interface: DatedList

Inserts an element into the list for a specified date range (optional operation).

Specified by:

add in interface DatedList

Overrides:

add in class AbstractDatedList

Parameters:

index - position to insert the element

value - element to insert

from - starting date at which the element should be inserted

to - ending date at which the element should be inserted

clear

public void clear(java.util.Date from,
                  java.util.Date to)

Description copied from interface: DatedCollection

Removes all elements from this dated collection for the specified dates (optional operation).

Specified by:

clear in interface DatedCollection

Overrides:

clear in class AbstractDatedList

Parameters:

from - date to start clearing the collection, inclusive

to - date to finish clearing the collection, exclusive

dateIterator

public DateIterator dateIterator(java.util.Date date)

Returns an iterator of the date ranges of when this dated object has changed, starting at the range that contains the specified date. Throughout a range returned by the iterator, the state of the dated object must be the same. Also, the states of the dated object must be different in two consecutive ranges returned by the iterator. There are no gaps in the ranges returned by the iterator. That is, if a previous date range exists, then a call to nextFrom returns the same date as previousTo. Passing MAX_DATE as the argument will return an iterator positioned at the end of the sequence.

Specified by:

dateIterator in interface DatedObject

Specified by:

dateIterator in class AbstractDatedCollection

Parameters:

date - date to position the iteration

Returns:

an iterator of the dates of when this dated type has changed, positioned immediately before the date range that contains the specified date

Throws:

java.lang.NullPointerException - if date is null

get

public java.lang.Object get(int index,
                            java.util.Date date)

Retrieves the element at the specified position on the specified date.

Specified by:

get in interface DatedList

Specified by:

get in class AbstractDatedList

Parameters:

index - position to retrieve an element

date - date at which this list is to be queried

Returns:

the element at the specified position on the specified date

Throws:

java.lang.NullPointerException - if date is null

java.lang.IllegalArgumentException - if index < 0

remove

public DatedValue remove(int index,
                         java.util.Date from,
                         java.util.Date to)

Description copied from interface: DatedList

Removes from this list the element at the specified position for the specified date range (optional operation).

Specified by:

remove in interface DatedList

Overrides:

remove in class AbstractDatedList

Parameters:

index - position at which to start the iteration

from - starting date at which the element should be removed

to - ending date at which the element should be removed

Returns:

the element at the specified index from this list for the specified date range.

set

public DatedValue set(int index,
                      java.lang.Object value,
                      java.util.Date from,
                      java.util.Date to)

Description copied from interface: DatedList

Replaces the element at the specified position with the specified element for the specified date range.

Specified by:

set in interface DatedList

Overrides:

set in class AbstractDatedList

Parameters:

index - position to place the element

value - element to place in this list

from - starting date at which the position should be set

to - ending date at which the position should be set

size

public int size(java.util.Date date)

Description copied from interface: DatedCollection

Returns the number of elements in this collection at the specified date.

Specified by:

size in interface DatedCollection

Specified by:

size in class AbstractDatedList

Parameters:

date - date at which this collection is to be queried

Returns:

the number of elements on the specified date