com.blackledge.david.game.crossword
Interface CrosswordSource

All Known Implementing Classes:
PuzCrosswordSource, QuizlandCrossword, QuizlandHardCrossword

public interface CrosswordSource

Interface to implement for other data sources for the Crossword game.

Version:
$Revision: 1.2 $

Method Summary
 CrosswordPuzzle getGame()
          Return the game object.
 HashMap getParamMap()
          All the params of the source...
 String getPuzzleId()
          Returns a unique id (if available) representing the current puzzle.
 void load()
          Load the source into the game object and validate it.
 void load(String puzzleId)
          Load the source into the game object and validate it.
 

Method Detail

getGame

CrosswordPuzzle getGame()
Return the game object. Called after load()

Returns:
the game object

getParamMap

HashMap getParamMap()
All the params of the source... typically includes a COPYRIGHT key.

Returns:
hashmap of name to value

load

void load()
Load the source into the game object and validate it.


getPuzzleId

String getPuzzleId()
Returns a unique id (if available) representing the current puzzle. If passed to load(String), this same puzzle will be loaded at that time.

Returns:
a String, or null if one is not available.

load

void load(String puzzleId)
Load the source into the game object and validate it.

Parameters:
puzzleId - a string previuosly returned from getPuzzleId() for this source.