gov.sandia.cognition.algorithm.event
Class AbstractIterativeAlgorithmListener

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.algorithm.event.AbstractIterativeAlgorithmListener
All Implemented Interfaces:
IterativeAlgorithmListener, CloneableSerializable, Serializable, Cloneable
Direct Known Subclasses:
IterationMeasurablePerformanceReporter, IterationStartReporter, IVotingCategorizerLearner.OutOfBagErrorStoppingCriteria, ProbabilisticLatentSemanticAnalysis.StatusPrinter

public abstract class AbstractIterativeAlgorithmListener
extends AbstractCloneableSerializable
implements IterativeAlgorithmListener

An abstract implementation of the IterativeAlgorithmListener interface that provides default implementations of the event methods that do nothing. It is meant so that listeners only need to implement the methods for the events they want to listen to.

Since:
3.3.3
Author:
Justin Basilico
See Also:
IterativeAlgorithmListener, Serialized Form

Constructor Summary
AbstractIterativeAlgorithmListener()
          Creates a new AbstractIterativeAlgorithmListener.
 
Method Summary
 void algorithmEnded(IterativeAlgorithm algorithm)
          This method is called when the algorithm has ended, after the last step of the algorithm.
 void algorithmStarted(IterativeAlgorithm algorithm)
          This method is called when a algorithm has started, before the first step of the algorithm.
 void stepEnded(IterativeAlgorithm algorithm)
          This method is called when the algorithm has ended a step of its execution.
 void stepStarted(IterativeAlgorithm algorithm)
          This method is called when the algorithm has started a step in its execution.
 
Methods inherited from class gov.sandia.cognition.util.AbstractCloneableSerializable
clone
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractIterativeAlgorithmListener

public AbstractIterativeAlgorithmListener()
Creates a new AbstractIterativeAlgorithmListener.

Method Detail

algorithmStarted

public void algorithmStarted(IterativeAlgorithm algorithm)
Description copied from interface: IterativeAlgorithmListener
This method is called when a algorithm has started, before the first step of the algorithm.

Specified by:
algorithmStarted in interface IterativeAlgorithmListener
Parameters:
algorithm - The algorithm that has started.

algorithmEnded

public void algorithmEnded(IterativeAlgorithm algorithm)
Description copied from interface: IterativeAlgorithmListener
This method is called when the algorithm has ended, after the last step of the algorithm.

Specified by:
algorithmEnded in interface IterativeAlgorithmListener
Parameters:
algorithm - The algorithm that has ended.

stepStarted

public void stepStarted(IterativeAlgorithm algorithm)
Description copied from interface: IterativeAlgorithmListener
This method is called when the algorithm has started a step in its execution.

Specified by:
stepStarted in interface IterativeAlgorithmListener
Parameters:
algorithm - The algorithm that has started another step of its execution.

stepEnded

public void stepEnded(IterativeAlgorithm algorithm)
Description copied from interface: IterativeAlgorithmListener
This method is called when the algorithm has ended a step of its execution.

Specified by:
stepEnded in interface IterativeAlgorithmListener
Parameters:
algorithm - The algorithm that has ended another step of its execution.