net.sourceforge.czt.animation.gui.history

Class BasicHistory

java.lang.Object

net.sourceforge.czt.animation.gui.history.HistorySupport

net.sourceforge.czt.animation.gui.history.BasicHistory

All Implemented Interfaces:

History

Direct Known Subclasses:

BirthdayBookFullHistory, BirthdayBookHistory, ZLiveHistory

public class BasicHistory
extends HistorySupport

Basic History Interface that provides the traditional back/forward mechanism.

Field Summary

Fields

Modifier and Type	Field and Description
protected ListIterator<SolutionSet>	currentSolution The iterator identifying the current solution set.
protected List<SolutionSet>	solutionSets The list of solution sets.

Fields inherited from class net.sourceforge.czt.animation.gui.history.HistorySupport

initSchema_, inputs_, propertyChangeSupport, stateSchema_

Constructor Summary

Constructors

Constructor and Description
BasicHistory() Basic constructor, initialises the list of solution sets to empty.
BasicHistory(String stateSchema, String initSchema)

Method Summary

Modifier and Type	Method and Description
void	activateSchema(String schemaName) Performs an operation from the current solution.
SolutionSet	getCurrentSolutionSet() Returns the current solution set.
String	getPositionLabel() Gives a label identifying the position in the history for use in GUI display.
boolean	hasNextSolutionSet()
boolean	hasPreviousSolutionSet()
void	nextSolutionSet() Moves to the next solution set.
void	previousSolutionSet() Moves to the previous solution set.

Methods inherited from class net.sourceforge.czt.animation.gui.history.HistorySupport

addInput, addInput, addInput, addPropertyChangeListener, addPropertyChangeListener, getCurrentSolution, getInitSchema, getInputs, getPropertyChangeListeners, getPropertyChangeListeners, getStateSchema, hasCurrentSolution, hasListeners, hasNextSolution, hasPreviousSolution, nextSolution, previousSolution, removePropertyChangeListener, removePropertyChangeListener, setInitSchema, setStateSchema

Methods inherited from class java.lang.Object

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

Field Detail

solutionSets

protected List<SolutionSet> solutionSets

The list of solution sets.

currentSolution

protected ListIterator<SolutionSet> currentSolution

The iterator identifying the current solution set. Because ListIterators identify a point between elements, and not a current element: the current solution is considered to be the one that would be returned by currentSolution.next(). This leads to a lot of extra fluffing around, so any code subclassing BasicHistory would do better to go through the public functions BasicHistory provides.

Constructor Detail

BasicHistory

public BasicHistory()

Basic constructor, initialises the list of solution sets to empty. An initialisation schema must be set before the history can be used.

See Also:

History.activateSchema(String)

BasicHistory

public BasicHistory(String stateSchema,
                    String initSchema)

Method Detail

getCurrentSolutionSet

public SolutionSet getCurrentSolutionSet()

Description copied from interface: History

Returns the current solution set.

Specified by:

getCurrentSolutionSet in interface History

Specified by:

getCurrentSolutionSet in class HistorySupport

Returns:

the current solution set, or null if the initialisation schema hasn't been set up yet.

activateSchema

public void activateSchema(String schemaName)

Description copied from interface: History

Performs an operation from the current solution. First call to activateSchema must be to set the initialisation schema.

Specified by:

activateSchema in interface History

Overrides:

activateSchema in class HistorySupport

hasNextSolutionSet

public boolean hasNextSolutionSet()

Returns:

true if there is another solution set after the current one.

nextSolutionSet

public void nextSolutionSet()

Moves to the next solution set.

hasPreviousSolutionSet

public boolean hasPreviousSolutionSet()

Returns:

true if there is another solution set before the current one.

previousSolutionSet

public void previousSolutionSet()

Moves to the previous solution set.

getPositionLabel

public String getPositionLabel()

Description copied from interface: History

Gives a label identifying the position in the history for use in GUI display.