Package ai.libs.jaicore.graphvisualizer.events.recorder

Class AlgorithmEventHistory

java.lang.Object

ai.libs.jaicore.graphvisualizer.events.recorder.AlgorithmEventHistory

All Implemented Interfaces:

java.io.Serializable, org.api4.java.common.control.ILoggingCustomizable

public class AlgorithmEventHistory
extends java.lang.Object
implements org.api4.java.common.control.ILoggingCustomizable, java.io.Serializable

An AlgorithmEventHistory stores AlgorithmEventHistoryEntrys constructed from IPropertyProcessedAlgorithmEvents representing the recorded behavior of an IAlgorithm. Such an AlgorithmEventHistory can be stored and loaded using an AlgorithmEventHistorySerializer.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AlgorithmEventHistory()	Creates a new AlgorithmEventHistory.
AlgorithmEventHistory(java.util.List<AlgorithmEventHistoryEntry> algorithmEventHistoryEntries)	Creates a new AlgorithmEventHistory with the given List of AlgorithmEventHistoryEntrys.

Method Summary

Modifier and Type	Method	Description
void	addEvent(org.api4.java.algorithm.events.serializable.IPropertyProcessedAlgorithmEvent propertyProcessedAlgorithmEvent)	Adds the given IPropertyProcessedAlgorithmEvent to this AlgorithmEventHistoryEntry.
boolean	equals(java.lang.Object obj)
AlgorithmEventHistoryEntry	getEntryAtTimeStep(int timestep)	Returns the AlgorithmEventHistoryEntry at the given timestep.
long	getLength()
java.lang.String	getLoggerName()
int	hashCode()
void	setLoggerName(java.lang.String name)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AlgorithmEventHistory

public AlgorithmEventHistory()

Creates a new AlgorithmEventHistory.

AlgorithmEventHistory

public AlgorithmEventHistory(java.util.List<AlgorithmEventHistoryEntry> algorithmEventHistoryEntries)

Creates a new AlgorithmEventHistory with the given List of AlgorithmEventHistoryEntrys.

Parameters:

algorithmEventHistoryEntries - The list of AlgorithmEventHistoryEntrys to be stored in the history.

Method Detail

addEvent

public void addEvent(org.api4.java.algorithm.events.serializable.IPropertyProcessedAlgorithmEvent propertyProcessedAlgorithmEvent)

Adds the given IPropertyProcessedAlgorithmEvent to this AlgorithmEventHistoryEntry.

Parameters:

propertyProcessedAlgorithmEvent - The IPropertyProcessedAlgorithmEvent to be added to this history.

getEntryAtTimeStep

public AlgorithmEventHistoryEntry getEntryAtTimeStep(int timestep)

Returns the AlgorithmEventHistoryEntry at the given timestep.

Parameters:

timestep - The timestep for which the AlgorithmEventHistoryEntry has to be returned.

Returns:

The AlgorithmEventHistoryEntry at the given timestep.

getLength

public long getLength()

getLoggerName

public java.lang.String getLoggerName()

Specified by:

getLoggerName in interface org.api4.java.common.control.ILoggingCustomizable

setLoggerName

public void setLoggerName(java.lang.String name)

Specified by:

setLoggerName in interface org.api4.java.common.control.ILoggingCustomizable

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object