cusack.hcg.graph

Class AbstractGraphProblem<V extends VertexData,E extends EdgeData>

java.lang.Object

cusack.hcg.graph.AbstractGraphProblem<V,E>

public abstract class AbstractGraphProblem<V extends VertexData,E extends EdgeData>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AbstractGraphProblem()

Method Summary

Modifier and Type	Method and Description
abstract PuzzleInstance	copyPuzzle() Make a copy of this object, but not exactly! IMPORTANT: This copy should make a copy so that the copy's initial settings are set to this objects current settings.
abstract VertexData	getDefaultVertexDataObject()
abstract java.lang.String	getProcessedSolution()
abstract int	getScore() Return the current score of the active game.
abstract PuzzleInstance	getTryItInstanceForUseOnPlayScreen() What kind of puzzle should the TryIt button produce? Return null if Try it is not applicable
abstract boolean	isCurrentStateValidSolution() Each instance needs to determine when the solution is valid.
abstract boolean	isEventForThisPuzzleType(Event<?> e) Return true iff this event is of type T.
abstract boolean	isSolutionRefinable() For optimization problems, for instance, this will return true.
abstract boolean	tryItResultsAreBinding()
abstract java.lang.String	uniqueIdentifier(Vertex v) Return a string that represents the data related to the given Vertex in a way that is different if the data is different.
abstract void	updateValidityBasedOnAlgorithmResult(boolean algorithmResult)
abstract boolean	usesAlgorithms() If the game related to this problem requires running algorithms, this should return true.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGraphProblem

public AbstractGraphProblem()

Method Detail

isCurrentStateValidSolution

public abstract boolean isCurrentStateValidSolution()

Each instance needs to determine when the solution is valid.

Returns:

usesAlgorithms

public abstract boolean usesAlgorithms()

If the game related to this problem requires running algorithms, this should return true. In addition there must be a class in the game package called FooAlgorithmRunner.

Returns:

updateValidityBasedOnAlgorithmResult

public abstract void updateValidityBasedOnAlgorithmResult(boolean algorithmResult)

isSolutionRefinable

public abstract boolean isSolutionRefinable()

For optimization problems, for instance, this will return true. For decision problems, this will generally return false.

Returns:

getTryItInstanceForUseOnPlayScreen

public abstract PuzzleInstance getTryItInstanceForUseOnPlayScreen()

What kind of puzzle should the TryIt button produce? Return null if Try it is not applicable

Returns:

tryItResultsAreBinding

public abstract boolean tryItResultsAreBinding()

isEventForThisPuzzleType

public abstract boolean isEventForThisPuzzleType(Event<?> e)

Return true iff this event is of type T. Stupid method that is necessary because Java is dumb. One would like to ask 'if(x instanceof T)', but since Java throws away Generics at runtime, it doesn't know what T is, so you can't ask this. This is an important method because (I think) that this is the only thing that ensure the right sort of objects are placed on history and the wrong ones aren't. Since the UndoRedoHistory is not properly parameterized (don't get me started on how much I hate Generics in Java) I think this method is the only thing that makes sure that if an RecordableEvent calls its performEvent method, that the PuzzleInstance object passed in is the correct one (for instance, a PebbleInstance must be passed if movePebbles is called since otherwise the program will crash). This may only be used in one place, but it is still necessary. CAC, Feb 2010.

Parameters:

e -

Returns:

copyPuzzle

public abstract PuzzleInstance copyPuzzle()

Make a copy of this object, but not exactly! IMPORTANT: This copy should make a copy so that the copy's initial settings are set to this objects current settings. This can probably just call the copy constructor defined in the subclass. This method should simply call the copy constructor for the puzzle.

Returns:

getScore

public abstract int getScore()

Return the current score of the active game. For many games this will simply be: return getNumberMoves(); For others it will be something else.

Returns:

getProcessedSolution

public abstract java.lang.String getProcessedSolution()

getDefaultVertexDataObject

public abstract VertexData getDefaultVertexDataObject()

uniqueIdentifier

public abstract java.lang.String uniqueIdentifier(Vertex v)

Return a string that represents the data related to the given Vertex in a way that is different if the data is different. e.g. if the only data is number of pebbles, it can just return the number of pebbles as a string. If there is no real data, returning an empty string is acceptable.

Returns: