chargerlib.history

Class ObjectHistory

Object

chargerlib.history.ObjectHistory

public class ObjectHistory
extends Object

Represents the provenance and subsequent transformations of a given object.

See Also:

GraphObjectHistoryRecord

Field Summary

Fields

Modifier and Type	Field and Description
private ArrayList<HistoryRecord>	history List of history events for an object.

Constructor Summary

Constructors

Constructor and Description
ObjectHistory()

Method Summary

Modifier and Type	Method and Description
void	addHistoryRecord(HistoryRecord he)
ObjectHistory	duplicateHistory() Make a copy of this history, using a clone-like copy for each event.
ArrayList<HistoryRecord>	getEventsByClass(Class c) Finds all events of the given type
ArrayList<HistoryRecord>	getEventsByType(String type) Finds all events of the given type
ArrayList<HistoryRecord>	getHistoryEvents() Returns the list of history events for this history.
HistoryRecord	getLastEvent() Get the last event in the list (which should be the most recent).
HistoryRecord	getNewestEventByType(String type) Finds the most recent (last) history event of the given type.
HistoryRecord	getOldestEventByType(String type) Finds the oldest (first) history event of the given type.
boolean	isEmpty()
String	toString()
String	toXML(String indent)

Methods inherited from class Object

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

Field Detail

history

private ArrayList<HistoryRecord> history

List of history events for an object. Should always add to the end, in chronologically ascending order.

Constructor Detail

ObjectHistory

public ObjectHistory()

Method Detail

addHistoryRecord

public void addHistoryRecord(HistoryRecord he)

getHistoryEvents

public ArrayList<HistoryRecord> getHistoryEvents()

Returns the list of history events for this history.

Returns:

duplicateHistory

public ObjectHistory duplicateHistory()

Make a copy of this history, using a clone-like copy for each event. This method relies on each event class concerned having a zero-argument constructor to be instantiated for copy. If any event in the history does not have such a constructor, then a message is displayed and the offending event is not instantiated, but the copy of succeeding events should proceed.

Returns:

A copy of this history, with new instances (copies) of all events in its list.

See Also:

HistoryRecord

isEmpty

public boolean isEmpty()

getLastEvent

public HistoryRecord getLastEvent()

Get the last event in the list (which should be the most recent).

Returns:

the last event in the history; null if there's no history.

getOldestEventByType

public HistoryRecord getOldestEventByType(String type)

Finds the oldest (first) history event of the given type.

Parameters:

type -

Returns:

the first history event of the given type found in the history list for an object. null if there isn't one

getNewestEventByType

public HistoryRecord getNewestEventByType(String type)

Finds the most recent (last) history event of the given type. If there is more than one, only one is chosen (probably the first one)

Parameters:

type -

Returns:

the first history event of the given type found in the history list for an object. null if there isn't one

getEventsByType

public ArrayList<HistoryRecord> getEventsByType(String type)

Finds all events of the given type

Parameters:

type - case-insensitive indicator of the type

Returns:

all events of the given type. If none found, then arraylist is empty, never null.

getEventsByClass

public ArrayList<HistoryRecord> getEventsByClass(Class c)

Finds all events of the given type

Parameters:

type - case-insensitive indicator of the type

Returns:

all events of the given type. If none found, then arraylist is empty, never null.

toString

public String toString()

Overrides:

toString in class Object

toXML

public String toXML(String indent)