Matrix

All Known Implementing Classes:

AbstractHeinekenGame, AbstractMatrix, BasicTestMatrix, ClientMatrix, HeinekenMathMatrix, HeinekenMatrix, HomeMatrix, PairPanickingMatrix
```
public interface Matrix
```
An interface representing a Matrix in a NetPuzl world

Version:

1.0

Author:

Heineken

See Also:

AbstractMatrix

Method Summary

All Methods Instance Methods Abstract Methods
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()` Creates a set Tag for this Matrix to be sent to a client
`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
`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
`Attributes`	`getAttributes()` Gets the attributes of 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.
`ObjID`	`getObjID()` Gets the object ID of this Matrix
`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 t)` 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()` Every Matrix in a NetPuzl world will have its own String representation

- Method Detail
  - addAgent
```
void addAgent(Agent agent)
```
    Adds an Agent to this Matrix
    
    Parameters:
    
    agent - The Agent to add to this Matrix
  - addKey
```
void addKey(Key key)
```
    Adds a Key to this Matrix
    
    Parameters:
    
    key - The Key to add to this Matrix
  - addToken
```
void addToken(Token token)
```
    Adds a Token to this Matrix
    
    Parameters:
    
    token - The Token to add to this Matrix
  - clearAgents
```
void clearAgents()
```
    Clears the Agents in this Matrix
  - clearKeys
```
void clearKeys()
```
    Clears the List of Keys in this Matrix
  - clearTokens
```
void clearTokens()
```
    Removes all Tokens from this Matrix's grid
  - contains
```
boolean contains(NetPuzlObject npo)
```
    Determines if this Matrix contains the given NetPuzlObject
    
    Parameters:
    
    npo - The NetPuzlObject to check for in this Matrix
    
    Returns:
    
    True if this Matrix contains the NetPuzlObject, false otherwise
  - containsImage
```
boolean containsImage(Image image)
```
    Determines if this Matrix contains the given Image
    
    Parameters:
    
    image - The Image to check for in this Matrix
    
    Returns:
    
    True if this Matrix contains the given Image, false otherwise
  - containsToken
```
boolean containsToken(Token token)
```
    Determines if this Matrix contains the given Token
    
    Parameters:
    
    token - The Token to check for in this Matrix
    
    Returns:
    
    True if this Matrix contains the given Token, false otherwise
  - createSetTag
```
TSet createSetTag()
```
    Creates a set Tag for this Matrix to be sent to a client
    
    Returns:
    
    A set Tag for this Matrix to be sent to a client
  - createSetTags
```
java.util.List<TSet> createSetTags()
```
    Creates setTtags for this Matrix and its Tokens, Keys, and Agents to be sent to a client
    
    Returns:
    
    A list of set Tags for this Matrix and its Tokens, Keys, and Agents to be sent to a client
  - createTokenSetTags
```
java.util.List<TSet> createTokenSetTags()
```
    Creates set Tags for this Matrix's Tokens to be sent to a client
    
    Returns:
    
    A list of set Tags for this Matrix's Tokens to be sent to a client
  - doSpokenCommand
```
void doSpokenCommand(java.lang.String text)
```
    Performs the command spoken to this Matrix
    
    Parameters:
    
    text - The command spoken to this Matrix
  - getAgentCount
```
int getAgentCount()
```
    Gets the number of Agents in this Matrix. Used for JUnit testing.
    
    Returns:
    
    The number of agents in this Matrix.
  - getAgentIterator
```
java.util.Iterator<Agent> getAgentIterator()
```
    Gets an iterator over the elements in the container for agents. Used for JUnit testing.
    
    Returns:
    
    An iterator over the elements in the Agent container
  - getAgents
```
java.util.Set<Agent> getAgents()
```
    Gets the Set of Agents in this Matrix
    
    Returns:
    
    The Set of Agents in this Matrix
  - getAttributes
```
Attributes getAttributes()
```
    Gets the attributes of this Matrix
    
    Returns:
    
    The attributes of this Matrix
  - getGrid
```
Cell[][] getGrid()
```
    A method used for testing that returns a reference to the 2-dimensional cell array or grid.
    
    Returns:
    
    A reference to this grid.
  - getGridCell
```
Cell getGridCell(int i,
                 int j)
```
    This method returns a particular Cell in the grid from the specified coordinates.
    
    Parameters:
    
    i - The column of the cell you want.
    
    j - The row of the Cell you want.
    
    Returns:
    
    The desired Cell.
  - getHeight
```
int getHeight()
```
    This method is used to get how tall the matrix is.
    
    Returns:
    
    The height, or y-dimension.
  - getImageCount
```
int getImageCount()
```
    Gets the number of Images from this Matrix, including images from the Matrix's Agents and Tokens
    
    Returns:
    
    The number of Images from this Matrix, including images from the Matrix's Agents and Tokens
  - getKeyCount
```
int getKeyCount()
```
    Gets the number of Keys from this Matrix. Used for JUnit testing.
    
    Returns:
    
    The number of keys in this Matrix
  - getKeyIterator
```
java.util.Iterator<Key> getKeyIterator()
```
    Gets an iterator over the elements in the container for keys. Used for JUnit testing.
    
    Returns:
    
    An iterator over the elements in the Key container
  - getObjID
```
ObjID getObjID()
```
    Gets the object ID of this Matrix
    
    Returns:
    
    The object ID of this Matrix
  - getSayFunction
```
SayFunction getSayFunction()
```
    Gets the function that processes spoken commands for this Matrix
    
    Returns:
    
    The function that processes spoken commands for this Matrix
  - getThis
```
AbstractMatrix getThis()
```
    Gets this Matrix for use in anonymous classes
    
    Returns:
    
    This Matrix
  - getTokenCount
```
int getTokenCount()
```
    Gets the number of Tokens in this Matrix
    
    Returns:
    
    The number of Tokens in this Matrix
  - getTokens
```
java.util.List<Token> getTokens()
```
    Gets the List of Tokens from this Matrix's grid
    
    Returns:
    
    The List of Tokens from this Matrix's grid
  - getWidth
```
int getWidth()
```
    This method is used to get how wide the matrix is.
    
    Returns:
    
    The width, or x-dimension.
  - hasSpokenCommand
```
boolean hasSpokenCommand()
```
    Determines if this Matrix has a function to process spoken commands
    
    Returns:
    
    Whether or not this Matrix has a function to process spoken commands
  - initCells
```
void initCells()
```
    Initializes the Cells contained in this Matrix to their associated x and y coordinates
  - removeAgent
```
void removeAgent(Agent agent)
```
    Removes an agent from this Matrix
    
    Parameters:
    
    agent - The Agent to remove from this Matrix
  - removeKey
```
void removeKey(Key key)
```
    Removes a key from this Matrix
    
    Parameters:
    
    key - Key to remove from this Matrix
  - removeToken
```
void removeToken(Token token)
```
    Removes a Token from this Matrix
    
    Parameters:
    
    token - The Token to remove from this Matrix
  - sendHearTagToMatrix
```
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
    
    Parameters:
    
    from - The NetPuzlObject to send the Tag from
    
    to - The NetPuzlObject to send the Tag to
    
    text - The message contained in the Tag
  - sendHearTagToNPO
```
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
    
    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
  - sendToAgentsInMatrix
```
void sendToAgentsInMatrix(Tag t)
```
    Sends a tag to all Agents in this Matrix
    
    Parameters:
    
    t - The tag to send to all Agents in this Matrix
  - setGrid
```
void setGrid(Cell[][] newGrid)
```
    A method used for testing that forces the grid to be the one that is given as a parameter.
    
    Parameters:
    
    newGrid - What the old grid should look like.
  - setGridCell
```
void setGridCell(int i,
                 int j,
                 Cell cell)
```
    A method used for testing that simply lets you set a Cell in the grid.
    
    Parameters:
    
    i - What column.
    
    j - What row.
    
    cell - What to set the grid location to.
  - setSayFunction
```
void setSayFunction(SayFunction sayFunction)
```
    Sets the function that processes spoken commands for this Matrix
    
    Parameters:
    
    sayFunction - The function that processes spoken commands to set this Matrix to
  - toString
```
java.lang.String toString()
```
    Every Matrix in a NetPuzl world will have its own String representation
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A String representation of the contents of the Matrix

Interface Matrix

Method Summary

Method Detail

addAgent

addKey

addToken

clearAgents

clearKeys

clearTokens

contains

containsImage

containsToken

createSetTag

createSetTags

createTokenSetTags

doSpokenCommand

getAgentCount

getAgentIterator

getAgents

getAttributes

getGrid

getGridCell

getHeight

getImageCount

getKeyCount

getKeyIterator

getObjID

getSayFunction

getThis

getTokenCount

getTokens

getWidth

hasSpokenCommand

initCells

removeAgent

removeKey

removeToken

sendHearTagToMatrix

sendHearTagToNPO

sendToAgentsInMatrix

setGrid

setGridCell

setSayFunction

toString