net.sourceforge.eclipsetrader.core.db
Class History

java.lang.Object
  java.util.Observable
      net.sourceforge.eclipsetrader.core.db.PersistentObject
          net.sourceforge.eclipsetrader.core.db.History

Direct Known Subclasses:

IntradayHistory

public class History

extends PersistentObject

Historical data.

Since:

1.0

Author:

Marco Maccaferri

Constructor Summary

History()
Constructs an empty history object.

History(java.lang.Integer id)
Constructs an empty history object with the given unique id.

Method Summary

int	add(Bar obj) Adds the specified element to this history, in date ascending order.
void	addAll(java.util.Collection collection) Adds all of the elements in the specified collection to this list, in date ascending order.
void	clear() Removes all of the elements from this history.
Bar	get(java.util.Date date) Returns the element with the specified date.
Bar	get(int index) Returns the element at the specified position in this list.
Bar	getFirst() Returns the first element in this history.
Bar	getLast() Returns the last element in this history.
java.util.List	getList() Returns an unmodifiable list of the elements in this history.
int	indexOf(java.util.Date date) Returns the index in this list of the first occurrence of the specified date, or -1 if this list does not contain this date.
boolean	isEmpty() Returns true if this history contains no elements.
java.util.Iterator	iterator() Returns an iterator over the elements in this history in proper sequence.
boolean	remove(Bar obj) Removes the first occurrence in this list of the specified element.
Bar	remove(int index) Removes the element at the specified position in this list.
int	size() Returns the number of elements in this history.
Bar[]	toArray() Returns an array containing all of the elements in this history in proper sequence.

Methods inherited from class net.sourceforge.eclipsetrader.core.db.PersistentObject

clearChanged, equals, getData, getId, getRepository, setChanged, setData, setId, setRepository

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

History

public History()

Constructs an empty history object.

History

public History(java.lang.Integer id)

Constructs an empty history object with the given unique id.

Parameters:

id - the unique id of this object

Method Detail

add

public int add(Bar obj)

Adds the specified element to this history, in date ascending order.

Parameters:

obj - element to be added to this list.

Returns:

the index of the element in the list.

Throws:

java.lang.IllegalArgumentException - if the specified element is null.

addAll

public void addAll(java.util.Collection collection)

Adds all of the elements in the specified collection to this list, in date ascending order. Elements that are not Bar objects are ignored.

Parameters:

collection - collection whose elements are to be added to this list.

remove

public Bar remove(int index)

Removes the element at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices).

Parameters:

index - the index of the element to removed.

Returns:

the element previously at the specified position.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

remove

public boolean remove(Bar obj)

Removes the first occurrence in this list of the specified element. If this list does not contain the element, it is unchanged.

Parameters:

obj - element to be removed from this list, if present.

Returns:

true if this list contained the specified element.

Throws:

java.lang.IllegalArgumentException - if the specified element is null.

clear

public void clear()

Removes all of the elements from this history.

size

public int size()

Returns the number of elements in this history.

Returns:

the number of elements in this history.

get

public Bar get(int index)

Returns the element at the specified position in this list.

Parameters:

index - index of element to return.

Returns:

the element at the specified position in this list.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

getFirst

public Bar getFirst()

Returns the first element in this history.

Returns:

the first element in this history, or null if the list is empty

getLast

public Bar getLast()

Returns the last element in this history.

Returns:

the last element in this history, or null if the list is empty

get

public Bar get(java.util.Date date)

Returns the element with the specified date.

Parameters:

date - the date of the element.

Returns:

the element with the specified date, or null if an element with the specified date is not found.

indexOf

public int indexOf(java.util.Date date)

Returns the index in this list of the first occurrence of the specified date, or -1 if this list does not contain this date.

Parameters:

date - date to search for.

Returns:

the index in this list of the first occurrence of the specified date, or -1 if this list does not contain this date.

iterator

public java.util.Iterator iterator()

Returns an iterator over the elements in this history in proper sequence.

Returns:

an iterator over the elements in this history.

isEmpty

public boolean isEmpty()

Returns true if this history contains no elements.

Returns:

true if this history contains no elements.

getList

public java.util.List getList()

Returns an unmodifiable list of the elements in this history.

Returns:

an unmodifiable list.

toArray

public Bar[] toArray()

Returns an array containing all of the elements in this history in proper sequence.

Returns:

an array containing all of the elements in this history in proper sequence.