org.jquantlib.cashflow

Class Event

java.lang.Object

org.jquantlib.cashflow.Event

All Implemented Interfaces:

Observable, PolymorphicVisitable

Direct Known Subclasses:

Callability, CashFlow

public abstract class Event
extends java.lang.Object
implements Observable, PolymorphicVisitable

This class is the base class for all financial events.

Method Summary

Modifier and Type	Method and Description
void	accept(PolymorphicVisitor pv) This method is intended to extend the semantics of method Visitable.accept(Visitor)
void	addObserver(Observer observer) Attaches a observer to the Observable.
int	countObservers() Counts how many Observers were attached to this class.
abstract Date	date() Keeps the date at which the event occurs
void	deleteObserver(Observer observer) Detaches a previously attached observer to the observable.
void	deleteObservers() Detaches all previously attached observer to the observable.
java.util.List<Observer>	getObservers() Returns list of observers registered with the Observable.
boolean	hasOccurred(Date d) Returns true if an event has already occurred before a date
boolean	hasOccurred(Date d, boolean includeToday) Returns true if an event has already occurred before a date where it is explicitly defined whether the current date must considered.
void	notifyObservers() Notifies all attached observers about changes in the observable.
void	notifyObservers(java.lang.Object arg) Notifies all attached observers about changes in the observable.

Methods inherited from class java.lang.Object

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

Method Detail

date

public abstract Date date()

Keeps the date at which the event occurs

hasOccurred

public boolean hasOccurred(Date d)

Returns true if an event has already occurred before a date

If Settings.isTodaysPayments() is true, then a payment event has not occurred if the input date is the same as the event date, and so includeToday should be defaulted to true.

This should be the only place in the code that is affected directly by Settings.isTodaysPayments()

hasOccurred

public boolean hasOccurred(Date d,
                           boolean includeToday)

Returns true if an event has already occurred before a date where it is explicitly defined whether the current date must considered.

Parameters:

d - is a Date

Returns:

true if an event has already occurred before a date

addObserver

public void addObserver(Observer observer)

Description copied from interface: Observable

Attaches a observer to the Observable. After attachment the observer gets informed about changes in the Observable.

Specified by:

addObserver in interface Observable

Parameters:

observer - The observer to attach to the observable

countObservers

public int countObservers()

Description copied from interface: Observable

Counts how many Observers were attached to this class.

Specified by:

countObservers in interface Observable

Returns:

the number of Observers

See Also:

Observer

deleteObserver

public void deleteObserver(Observer observer)

Description copied from interface: Observable

Detaches a previously attached observer to the observable. After detachment the observer does no longer receive change notifications from the observable.

Specified by:

deleteObserver in interface Observable

Parameters:

observer - The observer to detach from the observable

notifyObservers

public void notifyObservers()

Description copied from interface: Observable

Notifies all attached observers about changes in the observable.

Specified by:

notifyObservers in interface Observable

notifyObservers

public void notifyObservers(java.lang.Object arg)

Description copied from interface: Observable

Notifies all attached observers about changes in the observable.

Specified by:

notifyObservers in interface Observable

Parameters:

arg - an arbitrary Object to be passed to the Observer

deleteObservers

public void deleteObservers()

Description copied from interface: Observable

Detaches all previously attached observer to the observable. After detachment observers do not longer receive change notifications from the observable.

Specified by:

deleteObservers in interface Observable

getObservers

public java.util.List<Observer> getObservers()

Description copied from interface: Observable

Returns list of observers registered with the Observable. List returned is unmodifiable list.

Specified by:

getObservers in interface Observable

Returns:

list of observers

accept

public void accept(PolymorphicVisitor pv)

Description copied from interface: PolymorphicVisitable

This method is intended to extend the semantics of method Visitable.accept(Visitor)

In a conventional Visitor design pattern, the accept method is called when access to visit a data structure is requested. A Visitor object is passed as argument in case permission is granted to that Visitor to access the data structure. Obviously, Visitors and Visitables work in pairs and the class which provides the data structure to be visited also implements Visitable in order to properly grant access when the expected Visitor is received.

In the case of a PolymorphicVisitable, a PolymorphicVisitor is passed instead of a Visitor. A PolymorphicVisitor is in fact, a composition of Visitors and not only a single Visitor. A PolymorphicVisitor is responsible for returning the correct Visitor responsible for processing a certain data structure.

The initial design of pairs made of <Visitor,Visitable> is extended to a concept of a matrix made of multiple Visitors against multiple Visitables. Every class which implements PolymorphicVisitable passes different data structures when querying PolymorphicVisitors.

Specified by:

accept in interface PolymorphicVisitable

See Also:

PolymorphicVisitor#getVisitor(Class)