com.putable.common.matrix

Class AbstractMatrix

java.lang.Object

com.putable.common.matrix.NetPuzlObject

com.putable.common.matrix.AbstractMatrix

All Implemented Interfaces:

Matrix

Direct Known Subclasses:

AbstractHeinekenGame, BasicTestMatrix, ClientMatrix, HomeMatrix

public abstract class AbstractMatrix
extends NetPuzlObject
implements Matrix

An abstract implementation of a Matrix in a NetPuzl world

Version:

1.0

Author:

Heineken

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set<Agent>	agents The Agents contained in this Matrix
private Cell[][]	grid The two dimensional grid of Cells contained in this Matrix
private java.util.List<Key>	keys The Keys contained in this Matrix
private SayFunction	sayFunction The function that processes spoken commands for this Matrix

Constructor Summary

Constructors

Constructor and Description
AbstractMatrix(ObjID objID, Attributes attributes, java.util.Map<ObjID,NetPuzlObject> cache) Constructs an AbstractMatrix with the given parameters

Method Summary

Modifier and Type	Method and Description
void	addAgent(Agent agent) Adds an Agent to this Matrix
void	addKey(Key key) Adds a Key to this Matrix
void	addToken(Token token) Adds a Token to this Matrix
void	clearAgents() Clears the Agents in this Matrix
void	clearKeys() Clears the List of Keys in this Matrix
void	clearTokens() Removes all Tokens from this Matrix's grid
boolean	contains(NetPuzlObject npo) Determines if this Matrix contains the given NetPuzlObject
boolean	containsImage(Image image) Determines if this Matrix contains the given Image
boolean	containsToken(Token token) Determines if this Matrix contains the given Token
TSet	createSetTag() Overrides createSetTag because our Matrices do not use energy
java.util.List<TSet>	createSetTags() Creates setTtags for this Matrix and its Tokens, Keys, and Agents to be sent to a client
java.util.List<TSet>	createTokenSetTags() Creates set Tags for this Matrix's Tokens to be sent to a client
void	doSpokenCommand(java.lang.String text) Performs the command spoken to this Matrix
java.lang.String	fullToString() This shows the full toString object
int	getAgentCount() Gets the number of Agents in this Matrix.
java.util.Iterator<Agent>	getAgentIterator() Gets an iterator over the elements in the container for agents.
java.util.Set<Agent>	getAgents() Gets the Set of Agents in this Matrix
Cell[][]	getGrid() A method used for testing that returns a reference to the 2-dimensional cell array or grid.
Cell	getGridCell(int i, int j) This method returns a particular Cell in the grid from the specified coordinates.
int	getHeight() This method is used to get how tall the matrix is.
int	getImageCount() Gets the number of Images from this Matrix, including images from the Matrix's Agents and Tokens
int	getKeyCount() Gets the number of Keys from this Matrix.
java.util.Iterator<Key>	getKeyIterator() Gets an iterator over the elements in the container for keys.
SayFunction	getSayFunction() Gets the function that processes spoken commands for this Matrix
AbstractMatrix	getThis() Gets this Matrix for use in anonymous classes
int	getTokenCount() Gets the number of Tokens in this Matrix
java.util.List<Token>	getTokens() Gets the List of Tokens from this Matrix's grid
int	getWidth() This method is used to get how wide the matrix is.
boolean	hasSpokenCommand() Determines if this Matrix has a function to process spoken commands
void	initCells() Initializes the Cells contained in this Matrix to their associated x and y coordinates
void	removeAgent(Agent agent) Removes an agent from this Matrix
void	removeKey(Key key) Removes a key from this Matrix
void	removeToken(Token token) Removes a Token from this Matrix
void	sendHearTagToMatrix(NetPuzlObject from, NetPuzlObject to, java.lang.String text) Sends a 'hear' Tag from one NetPuzlObject to another to be broadcast to all Agents in this Matrix
void	sendHearTagToNPO(NetPuzlClientProxy proxy, NetPuzlObject from, NetPuzlObject to, java.lang.String text) Sends a 'hear' Tag from one NetPuzlObject to another to be broadcast to the Agent involved
void	sendToAgentsInMatrix(Tag tag) Sends a tag to all Agents in this Matrix
void	setGrid(Cell[][] newGrid) A method used for testing that forces the grid to be the one that is given as a parameter.
void	setGridCell(int i, int j, Cell cell) A method used for testing that simply lets you set a Cell in the grid.
void	setSayFunction(SayFunction sayFunction) Sets the function that processes spoken commands for this Matrix
java.lang.String	toString() A simple String representation of this NetPuzlObject

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

agents

private java.util.Set<Agent> agents

The Agents contained in this Matrix

keys

private java.util.List<Key> keys

The Keys contained in this Matrix

grid

private Cell[][] grid

The two dimensional grid of Cells contained in this Matrix

sayFunction

private SayFunction sayFunction

The function that processes spoken commands for this Matrix

Constructor Detail

AbstractMatrix

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

Constructs an AbstractMatrix with the given parameters

Parameters:

objID - The object ID of this Matrix

attributes - The Attributes of this Matrix

cache - The Map to cache this Matrix in

Method Detail

addAgent

public void addAgent(Agent agent)

Description copied from interface: Matrix

Adds an Agent to this Matrix

Specified by:

addAgent in interface Matrix

Parameters:

agent - The Agent to add to this Matrix

See Also:

Matrix.addAgent(com.putable.common.matrix.Agent)

addKey

public void addKey(Key key)

Description copied from interface: Matrix

Adds a Key to this Matrix

Specified by:

addKey in interface Matrix

Parameters:

key - The Key to add to this Matrix

See Also:

Matrix.addKey(com.putable.common.matrix.Key)

addToken

public void addToken(Token token)

Description copied from interface: Matrix

Adds a Token to this Matrix

Specified by:

addToken in interface Matrix

Parameters:

token - The Token to add to this Matrix

See Also:

Matrix.addToken(com.putable.common.matrix.Token)

clearAgents

public void clearAgents()

Description copied from interface: Matrix

Clears the Agents in this Matrix

Specified by:

clearAgents in interface Matrix

See Also:

Matrix.clearAgents()

clearKeys

public void clearKeys()

Description copied from interface: Matrix

Clears the List of Keys in this Matrix

Specified by:

clearKeys in interface Matrix

See Also:

Matrix.clearKeys()

clearTokens

public void clearTokens()

Description copied from interface: Matrix

Removes all Tokens from this Matrix's grid

Specified by:

clearTokens in interface Matrix

See Also:

Matrix.clearTokens()

contains

public boolean contains(NetPuzlObject npo)

Description copied from interface: Matrix

Determines if this Matrix contains the given NetPuzlObject

Specified by:

contains in interface Matrix

Parameters:

npo - The NetPuzlObject to check for in this Matrix

Returns:

True if this Matrix contains the NetPuzlObject, false otherwise

See Also:

Matrix.contains(com.putable.common.matrix.NetPuzlObject)

containsImage

public boolean containsImage(Image image)

Description copied from interface: Matrix

Determines if this Matrix contains the given Image

Specified by:

containsImage in interface Matrix

Parameters:

image - The Image to check for in this Matrix

Returns:

True if this Matrix contains the given Image, false otherwise

See Also:

Matrix.containsImage(com.putable.common.matrix.Image)

containsToken

public boolean containsToken(Token token)

Description copied from interface: Matrix

Determines if this Matrix contains the given Token

Specified by:

containsToken in interface Matrix

Parameters:

token - The Token to check for in this Matrix

Returns:

True if this Matrix contains the given Token, false otherwise

See Also:

Matrix.containsToken(com.putable.common.matrix.Token)

createSetTag

public TSet createSetTag()

Overrides createSetTag because our Matrices do not use energy

Specified by:

createSetTag in interface Matrix

Overrides:

createSetTag in class NetPuzlObject

Returns:

A set tag of this NetPuzlObject to be sent to a client

See Also:

NetPuzlObject.createSetTag()

createSetTags

public java.util.List<TSet> createSetTags()

Description copied from interface: Matrix

Creates setTtags for this Matrix and its Tokens, Keys, and Agents to be sent to a client

Specified by:

createSetTags in interface Matrix

Returns:

A list of set Tags for this Matrix and its Tokens, Keys, and Agents to be sent to a client

See Also:

Matrix.createSetTags()

createTokenSetTags

public java.util.List<TSet> createTokenSetTags()

Description copied from interface: Matrix

Creates set Tags for this Matrix's Tokens to be sent to a client

Specified by:

createTokenSetTags in interface Matrix

Returns:

A list of set Tags for this Matrix's Tokens to be sent to a client

See Also:

Matrix.createTokenSetTags()

doSpokenCommand

public void doSpokenCommand(java.lang.String text)

Description copied from interface: Matrix

Performs the command spoken to this Matrix

Specified by:

doSpokenCommand in interface Matrix

Parameters:

text - The command spoken to this Matrix

See Also:

Matrix.doSpokenCommand(java.lang.String)

getAgentCount

public int getAgentCount()

Description copied from interface: Matrix

Gets the number of Agents in this Matrix. Used for JUnit testing.

Specified by:

getAgentCount in interface Matrix

Returns:

The number of agents in this Matrix.

See Also:

Matrix.getAgentCount()

getAgentIterator

public java.util.Iterator<Agent> getAgentIterator()

Description copied from interface: Matrix

Gets an iterator over the elements in the container for agents. Used for JUnit testing.

Specified by:

getAgentIterator in interface Matrix

Returns:

An iterator over the elements in the Agent container

See Also:

Matrix.getAgentIterator()

getAgents

public java.util.Set<Agent> getAgents()

Description copied from interface: Matrix

Gets the Set of Agents in this Matrix

Specified by:

getAgents in interface Matrix

Returns:

The Set of Agents in this Matrix

See Also:

Matrix.getAgents()

getGrid

public Cell[][] getGrid()

Description copied from interface: Matrix

A method used for testing that returns a reference to the 2-dimensional cell array or grid.

Specified by:

getGrid in interface Matrix

Returns:

A reference to this grid.

See Also:

Matrix.getGrid()

getGridCell

public Cell getGridCell(int i,
                        int j)

Description copied from interface: Matrix

This method returns a particular Cell in the grid from the specified coordinates.

Specified by:

getGridCell in interface Matrix

Parameters:

i - The column of the cell you want.

j - The row of the Cell you want.

Returns:

The desired Cell.

See Also:

Matrix.getGridCell(int, int)

getHeight

public int getHeight()

Description copied from interface: Matrix

This method is used to get how tall the matrix is.

Specified by:

getHeight in interface Matrix

Returns:

The height, or y-dimension.

See Also:

Matrix.getHeight()

getImageCount

public int getImageCount()

Description copied from interface: Matrix

Gets the number of Images from this Matrix, including images from the Matrix's Agents and Tokens

Specified by:

getImageCount in interface Matrix

Returns:

The number of Images from this Matrix, including images from the Matrix's Agents and Tokens

See Also:

Matrix.getImageCount()

getKeyCount

public int getKeyCount()

Description copied from interface: Matrix

Gets the number of Keys from this Matrix. Used for JUnit testing.

Specified by:

getKeyCount in interface Matrix

Returns:

The number of keys in this Matrix

See Also:

Matrix.getKeyCount()

getKeyIterator

public java.util.Iterator<Key> getKeyIterator()

Description copied from interface: Matrix

Gets an iterator over the elements in the container for keys. Used for JUnit testing.

Specified by:

getKeyIterator in interface Matrix

Returns:

An iterator over the elements in the Key container

See Also:

Matrix.getKeyIterator()

getSayFunction

public SayFunction getSayFunction()

Description copied from interface: Matrix

Gets the function that processes spoken commands for this Matrix

Specified by:

getSayFunction in interface Matrix

Returns:

The function that processes spoken commands for this Matrix

See Also:

Matrix.getSayFunction()

getThis

public AbstractMatrix getThis()

Description copied from interface: Matrix

Gets this Matrix for use in anonymous classes

Specified by:

getThis in interface Matrix

Returns:

This Matrix

See Also:

Matrix.getThis()

getTokenCount

public int getTokenCount()

Description copied from interface: Matrix

Gets the number of Tokens in this Matrix

Specified by:

getTokenCount in interface Matrix

Returns:

The number of Tokens in this Matrix

See Also:

Matrix.getTokenCount()

getTokens

public java.util.List<Token> getTokens()

Description copied from interface: Matrix

Gets the List of Tokens from this Matrix's grid

Specified by:

getTokens in interface Matrix

Returns:

The List of Tokens from this Matrix's grid

See Also:

Matrix.getTokens()

getWidth

public int getWidth()

Description copied from interface: Matrix

This method is used to get how wide the matrix is.

Specified by:

getWidth in interface Matrix

Returns:

The width, or x-dimension.

See Also:

Matrix.getWidth()

hasSpokenCommand

public boolean hasSpokenCommand()

Description copied from interface: Matrix

Determines if this Matrix has a function to process spoken commands

Specified by:

hasSpokenCommand in interface Matrix

Returns:

Whether or not this Matrix has a function to process spoken commands

See Also:

Matrix.hasSpokenCommand()

initCells

public void initCells()

Description copied from interface: Matrix

Initializes the Cells contained in this Matrix to their associated x and y coordinates

Specified by:

initCells in interface Matrix

See Also:

Matrix.initCells()

removeAgent

public void removeAgent(Agent agent)

Description copied from interface: Matrix

Removes an agent from this Matrix

Specified by:

removeAgent in interface Matrix

Parameters:

agent - The Agent to remove from this Matrix

See Also:

Matrix.removeAgent(com.putable.common.matrix.Agent)

removeKey

public void removeKey(Key key)

Description copied from interface: Matrix

Removes a key from this Matrix

Specified by:

removeKey in interface Matrix

Parameters:

key - Key to remove from this Matrix

See Also:

Matrix.removeKey(com.putable.common.matrix.Key)

removeToken

public void removeToken(Token token)

Description copied from interface: Matrix

Removes a Token from this Matrix

Specified by:

removeToken in interface Matrix

Parameters:

token - The Token to remove from this Matrix

See Also:

Matrix.removeToken(com.putable.common.matrix.Token)

sendHearTagToMatrix

public void sendHearTagToMatrix(NetPuzlObject from,
                                NetPuzlObject to,
                                java.lang.String text)

Description copied from interface: Matrix

Sends a 'hear' Tag from one NetPuzlObject to another to be broadcast to all Agents in this Matrix

Specified by:

sendHearTagToMatrix in interface Matrix

Parameters:

from - The NetPuzlObject to send the Tag from

to - The NetPuzlObject to send the Tag to

text - The message contained in the Tag

See Also:

Matrix.sendHearTagToMatrix(NetPuzlObject from, NetPuzlObject to, String text)

sendHearTagToNPO

public void sendHearTagToNPO(NetPuzlClientProxy proxy,
                             NetPuzlObject from,
                             NetPuzlObject to,
                             java.lang.String text)

Description copied from interface: Matrix

Sends a 'hear' Tag from one NetPuzlObject to another to be broadcast to the Agent involved

Specified by:

sendHearTagToNPO in interface Matrix

Parameters:

proxy - The client proxy to send the Tag to

from - The NetPuzlObject to send the Tag from

to - The NetPuzlObject to send the Tag to

text - The message contained in the Tag

See Also:

Matrix.sendHearTagToNPO(NetPuzlClientProxy proxy, NetPuzlObject from, NetPuzlObject to, String text)

sendToAgentsInMatrix

public void sendToAgentsInMatrix(Tag tag)

Description copied from interface: Matrix

Sends a tag to all Agents in this Matrix

Specified by:

sendToAgentsInMatrix in interface Matrix

Parameters:

tag - The tag to send to all Agents in this Matrix

See Also:

Matrix.sendToAgentsInMatrix(Tag tag)

setGrid

public void setGrid(Cell[][] newGrid)

Description copied from interface: Matrix

A method used for testing that forces the grid to be the one that is given as a parameter.

Specified by:

setGrid in interface Matrix

Parameters:

newGrid - What the old grid should look like.

See Also:

Matrix.setGrid(com.putable.common.matrix.Cell[][])

setGridCell

public void setGridCell(int i,
                        int j,
                        Cell cell)

Description copied from interface: Matrix

A method used for testing that simply lets you set a Cell in the grid.

Specified by:

setGridCell in interface Matrix

Parameters:

i - What column.

j - What row.

cell - What to set the grid location to.

See Also:

Matrix.setGridCell(int, int, com.putable.common.matrix.Cell)

setSayFunction

public void setSayFunction(SayFunction sayFunction)

Description copied from interface: Matrix

Sets the function that processes spoken commands for this Matrix

Specified by:

setSayFunction in interface Matrix

Parameters:

sayFunction - The function that processes spoken commands to set this Matrix to

See Also:

Matrix.setSayFunction(com.putable.common.matrix.SayFunction)

fullToString

public java.lang.String fullToString()

This shows the full toString object

Overrides:

fullToString in class NetPuzlObject

toString

public java.lang.String toString()

Description copied from class: NetPuzlObject

A simple String representation of this NetPuzlObject

Specified by:

toString in interface Matrix

Overrides:

toString in class NetPuzlObject

Returns:

A String representation of the contents of the Matrix

See Also:

Matrix.toString()