com.putable.server.matrix

Class AbstractHeinekenGame

java.lang.Object

com.putable.common.matrix.NetPuzlObject

com.putable.common.matrix.AbstractMatrix

com.putable.server.matrix.AbstractHeinekenGame

All Implemented Interfaces:

Matrix

Direct Known Subclasses:

HeinekenMathMatrix, HeinekenMatrix, PairPanickingMatrix

public abstract class AbstractHeinekenGame
extends AbstractMatrix

An abstract implementation of a Heineken game

Version:

1.0

Author:

Heineken

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<ObjID,NetPuzlObject>	cache The cache that links object IDs to their NetPuzlObjects
private StatusType	gameStatus The current status of this Heineken Math game
private int	numSolved The current number of solved squares in this Heineken game
private Token	start The 'Start' button of this Heineken game, or null if none
private Token	status The 'Status' button of this Heineken game

Constructor Summary

Constructors

Constructor and Description
AbstractHeinekenGame(ObjID objID, Attributes attributes, java.util.Map<ObjID,NetPuzlObject> cache) Constructs a Heineken game with the given parameters

Method Summary

Modifier and Type	Method and Description
void	gameOver() Determines the winner of this Heineken game, if any, and sends a congratulations message to all Agents in the Matrix if it finds a winner
java.util.Map<ObjID,NetPuzlObject>	getCache() Gets the cache that links object IDs to their NetPuzlObjects
StatusType	getGameStatus() Gets the current status of this Heineken game
int	getNumSolved() Gets the current number of solved squares in this Heineken game
Token	getStartToken() Gets the 'Start' button of this Heineken game
Token	getStatusToken() Gets the 'Status' button of this Heineken game
boolean	isReady() Determines whether or not the game status is 'READY'
void	loadStatusToken() Loads the 'Status' Token of this Heineken game
void	setAgentEnergy(Agent agent, int energy) Sets the energy Attribute of an Agent
void	setGameStatus(StatusType gameStatus) Sets the current game status of this Heineken game
void	setNumSolved(int numSolved) Sets the current number of solved squares in this Heineken game
void	setStartToken(Token start) Sets the 'Start' button of this Heineken game
void	setStatus(StatusType statusType) Sets the current status of this Heineken game
void	setStatusToken(Token status) Sets the 'Status' button of this Heineken game

Methods inherited from class com.putable.common.matrix.AbstractMatrix

addAgent, addKey, addToken, clearAgents, clearKeys, clearTokens, contains, containsImage, containsToken, createSetTag, createSetTags, createTokenSetTags, doSpokenCommand, fullToString, getAgentCount, getAgentIterator, getAgents, getGrid, getGridCell, getHeight, getImageCount, getKeyCount, getKeyIterator, getSayFunction, getThis, getTokenCount, getTokens, getWidth, hasSpokenCommand, initCells, removeAgent, removeKey, removeToken, sendHearTagToMatrix, sendHearTagToNPO, sendToAgentsInMatrix, setGrid, setGridCell, setSayFunction, toString

Methods inherited from class com.putable.common.matrix.NetPuzlObject

getAttributes, getObjID, setAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.putable.common.matrix.Matrix

getAttributes, getObjID

Field Detail

start

private Token start

The 'Start' button of this Heineken game, or null if none

status

private Token status

The 'Status' button of this Heineken game

gameStatus

private StatusType gameStatus

The current status of this Heineken Math game

cache

private java.util.Map<ObjID,NetPuzlObject> cache

The cache that links object IDs to their NetPuzlObjects

numSolved

private int numSolved

The current number of solved squares in this Heineken game

Constructor Detail

AbstractHeinekenGame

public AbstractHeinekenGame(ObjID objID,
                            Attributes attributes,
                            java.util.Map<ObjID,NetPuzlObject> cache)

Constructs a Heineken game with the given parameters

Parameters:

objID - The object ID to construct this Heineken game with

attributes - The Attributes to construct this Heineken game with

cache - The Map to cache this Heineken game in

Method Detail

loadStatusToken

public void loadStatusToken()

Loads the 'Status' Token of this Heineken game

setStatus

public void setStatus(StatusType statusType)

Sets the current status of this Heineken game

Parameters:

statusType - The StatusType to set this Heineken game to

setAgentEnergy

public void setAgentEnergy(Agent agent,
                           int energy)

Sets the energy Attribute of an Agent

Parameters:

agent - The Agent whose energy to set

energy - The energy to set the Agent's Attribute to

gameOver

public void gameOver()

Determines the winner of this Heineken game, if any, and sends a congratulations message to all Agents in the Matrix if it finds a winner

getStartToken

public Token getStartToken()

Gets the 'Start' button of this Heineken game

Returns:

The 'Start' button of this Heineken game

setStartToken

public void setStartToken(Token start)

Sets the 'Start' button of this Heineken game

Parameters:

start - The 'Start' button to set this Heineken game to

getStatusToken

public Token getStatusToken()

Gets the 'Status' button of this Heineken game

Returns:

The 'Status' button of this Heineken game

setStatusToken

public void setStatusToken(Token status)

Sets the 'Status' button of this Heineken game

Parameters:

status - The 'Status' button to set this Heineken game to

getGameStatus

public StatusType getGameStatus()

Gets the current status of this Heineken game

Returns:

The current status of this Heineken game

setGameStatus

public void setGameStatus(StatusType gameStatus)

Sets the current game status of this Heineken game

Parameters:

gameStatus - The current game status to set this Heineken game to

isReady

public boolean isReady()

Determines whether or not the game status is 'READY'

Returns:

True if the game status is 'READY', false otherwise

getCache

public java.util.Map<ObjID,NetPuzlObject> getCache()

Gets the cache that links object IDs to their NetPuzlObjects

getNumSolved

public int getNumSolved()

Gets the current number of solved squares in this Heineken game

Returns:

The current number of solved squares in this Heineken game

setNumSolved

public void setNumSolved(int numSolved)

Sets the current number of solved squares in this Heineken game

Parameters:

numSolved - The current number of solved squares to set this Heineken game to