cusack.hcg.graph.algorithm

Class AlgorithmWrapper

java.lang.Object

java.util.Observable

cusack.hcg.graph.algorithm.AlgorithmWrapper

All Implemented Interfaces:

java.lang.Runnable

public class AlgorithmWrapper
extends java.util.Observable
implements java.lang.Runnable

A generic class that all algorithms will inherit from.

Author:

Charles Cusack, 6/2013

Constructor Summary

Constructors

Constructor and Description
AlgorithmWrapper(AlgorithmInterface<? extends PuzzleInstance> algorithm, PuzzleInstance puzzle) Construct an object that will allow us to run the given algorithm on the given puzzle.

Method Summary

Modifier and Type	Method and Description
AlgorithmInterface	getAlgorithm()
java.lang.String	getAlgorithmName()
PuzzleInstance	getCurrentPuzzle() Return the puzzle after updating the data based on the progress of the algorithm
long	getElapsedTimeInMillis()
int	getPuzzleID()
Solution	getSolution()
boolean	isAutoSave()
boolean	isRunning()
void	requestQuit()
void	run()
boolean	runInThread(java.util.Observer observer) Run the algorithm in a thread.
void	saveOrReplaceAlgorithmSolution()
void	setAutoSave(boolean autoSave)

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Constructor Detail

AlgorithmWrapper

public AlgorithmWrapper(AlgorithmInterface<? extends PuzzleInstance> algorithm,
                        PuzzleInstance puzzle)

Construct an object that will allow us to run the given algorithm on the given puzzle. It is assumed that both the algorithm and the puzzle have been copied, if necessary, since they both will be used directly (i.e. no copy of either will be made). The algorithm will be given the data from the puzzle, and the puzzle will be updated periodically with the progress of the algorithm.

Parameters:

algorithm - An instance of the algorithm to be run.

puzzle - The puzzle to run the algorithm on.

Method Detail

isRunning

public boolean isRunning()

getCurrentPuzzle

public PuzzleInstance getCurrentPuzzle()

Return the puzzle after updating the data based on the progress of the algorithm

Returns:

getPuzzleID

public int getPuzzleID()

saveOrReplaceAlgorithmSolution

public void saveOrReplaceAlgorithmSolution()

getSolution

public Solution getSolution()

getAlgorithmName

public java.lang.String getAlgorithmName()

isAutoSave

public boolean isAutoSave()

setAutoSave

public void setAutoSave(boolean autoSave)

getAlgorithm

public AlgorithmInterface getAlgorithm()

getElapsedTimeInMillis

public long getElapsedTimeInMillis()

requestQuit

public void requestQuit()

runInThread

public boolean runInThread(java.util.Observer observer)

Run the algorithm in a thread. Return true if it is run, and false if it is not run (because it is already running or has already run and is done).

Parameters:

observer - An object that wants to be notified that the thread has started and stopped.

Returns:

run

public void run()

Specified by:

run in interface java.lang.Runnable