org.uob.braveapi.dispatcher.api

Class DispatchRecord

java.lang.Object

org.uob.braveapi.dispatcher.api.DispatchRecord

All Implemented Interfaces:

java.lang.Comparable<DispatchRecord>

public class DispatchRecord
extends java.lang.Object
implements java.lang.Comparable<DispatchRecord>

A DispatchRecord consists of a train and a time that it is due to be dispatched. It is created and stored in the dispatcher component when a train stops. Once the time of the dispatch record is reached, the dispatcher will dispatch the train by setting its dispatch status to DISPATCHED. Dispatch records exists for the duration of a train's dwell.

Constructor Summary

Constructors

Constructor and Description
DispatchRecord(APITime time, java.lang.String train) Construct a Dispatch Record.

Method Summary

Modifier and Type	Method and Description
int	compareTo(DispatchRecord o) Compare the time of this dispatch record, with the time of the specified record.
APITime	getTime() Gets the time of dispatch for this record.
java.lang.String	getTrain() Gets the train for which this dispatch record refers to.
void	setTime(APITime time) Sets the time for the dispatch in this record

Methods inherited from class java.lang.Object

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

Constructor Detail

DispatchRecord

public DispatchRecord(APITime time,
                      java.lang.String train)

Construct a Dispatch Record.

Parameters:

time -

train -

Method Detail

getTime

public APITime getTime()

Gets the time of dispatch for this record.

Returns:

setTime

public void setTime(APITime time)

Sets the time for the dispatch in this record

Parameters:

time -

getTrain

public java.lang.String getTrain()

Gets the train for which this dispatch record refers to.

Returns:

compareTo

public int compareTo(DispatchRecord o)

Compare the time of this dispatch record, with the time of the specified record.

Specified by:

compareTo in interface java.lang.Comparable<DispatchRecord>