Package adams.gui.flow.tree.record.add

Class AbstractRecordActorAdded

java.lang.Object

adams.core.logging.ConsoleLoggingObject

adams.gui.flow.tree.record.add.AbstractRecordActorAdded

All Implemented Interfaces:

CleanUpHandler, Serializable

Direct Known Subclasses:

MostCommon, SimpleLog

public abstract class AbstractRecordActorAdded
extends ConsoleLoggingObject
implements CleanUpHandler

Ancestor schemes that record when an actor got added.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static List<AbstractRecordActorAdded>	m_Recorders	the available recording schemes.

Fields inherited from class adams.core.logging.ConsoleLoggingObject

m_Logger

Constructor Summary

Constructors

Constructor	Description
AbstractRecordActorAdded()

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	Cleans up data structures, frees up memory.
static void	cleanUpAll()	Cleans up data structures, frees up memory, for all recorders.
abstract boolean	isEnabled(Node added)	Returns whether the recording is active.
protected abstract void	record(Actor added, Actor parent, Actor before, Actor after, TreeOperations.InsertPosition position)	Records the actor that was added.
void	record(Node added, Node parent, TreeOperations.InsertPosition position)	Records the actor that was added.
static void	recordAll(Node added, Node parent, TreeOperations.InsertPosition position)	Records the actor that was added.

Methods inherited from class adams.core.logging.ConsoleLoggingObject

getLogger, initializeLogger, isLoggingEnabled

Methods inherited from class java.lang.Object

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

Field Detail

m_Recorders

protected static List<AbstractRecordActorAdded> m_Recorders

the available recording schemes.

Constructor Detail

AbstractRecordActorAdded

public AbstractRecordActorAdded()

Method Detail

isEnabled

public abstract boolean isEnabled(Node added)

Returns whether the recording is active.

Parameters:

added - the node that got added (for context)

Returns:

true if active

record

protected abstract void record(Actor added,
                               Actor parent,
                               Actor before,
                               Actor after,
                               TreeOperations.InsertPosition position)

Records the actor that was added.

Parameters:

added - the actor that was added

parent - the parent of the added actor

before - the immediate actor before the added actor, can be null

after - the immediate actor after the added actor, can be null

position - how the actor was added

record

public void record(Node added,
                   Node parent,
                   TreeOperations.InsertPosition position)

Records the actor that was added.

Parameters:

added - the node that was added

parent - the parent of the added actor

position - how the actor was added

cleanUp

public void cleanUp()

Cleans up data structures, frees up memory.
Default implementation does nothing.

Specified by:

cleanUp in interface CleanUpHandler

recordAll

public static void recordAll(Node added,
                             Node parent,
                             TreeOperations.InsertPosition position)

Records the actor that was added.

Parameters:

added - the node that was added

parent - the parent of the added actor

position - how the actor was added

cleanUpAll

public static void cleanUpAll()

Cleans up data structures, frees up memory, for all recorders.