edu.usc.ict.iago.utils

Class Mediator

java.lang.Object

edu.usc.ict.iago.utils.Mediator

public class Mediator
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	gameInProgress
(package private) GameSpec	spec
(package private) GameBridgeUtils	utils

Constructor Summary

Constructors

Constructor and Description
Mediator(GameBridgeUtils u) The constructor for the Mediator.

Method Summary

Modifier and Type	Method and Description
(package private) void	addToAgent(Event e) Adds an event to the queue to be sent to the corresponding agent.
(package private) void	clearAgentQueue() Used when an Event comes in that signals the end of the game.
(package private) boolean	isActivePage() Returns whether or not the Mediator has received a signal from the webpage recently.
(package private) boolean	isPageOpen() Returns whether or not the webpage is open.
(package private) void	makeRunnable() A method to be called by GBU to indicate that the Mediator's VHRunner can run.
boolean	pendingAgentEvent() Called by the associated VHRunner to determine whether or not this Mediator holds an Event for it to look at.
(package private) void	setActivePage(boolean activePage) A method to toggle the activePage field of this object.
(package private) void	setGameSpec(GameSpec newSpec) Changes the GameSpec of the Mediator.
(package private) void	stopRunning() A method to be called by GBU or the Mediator's VHRunner to indicate that the VHRunner should stop running.
(package private) Event	takeForAgent() Takes an Event from the queue so that the VHRunner can use the Event.

Methods inherited from class java.lang.Object

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

Field Detail

gameInProgress

boolean gameInProgress

spec

GameSpec spec

utils

GameBridgeUtils utils

Constructor Detail

Mediator

Mediator(GameBridgeUtils u)

The constructor for the Mediator. This constructor should only be called by GBU, and GBU should pass itself as the argument.

Parameters:

u - A reference to GBU

Method Detail

setGameSpec

void setGameSpec(GameSpec newSpec)

Changes the GameSpec of the Mediator. Should only be called by GBU.

Parameters:

newSpec - the new GameSpec to be used.

addToAgent

void addToAgent(Event e)

Adds an event to the queue to be sent to the corresponding agent. Will only add the event if there is currently no game in progress and the event is a GAME_START event or if there is a game in progress. If the Event signals end of a game in any way (i.e., timed out, formal accept, formal quit), the queue will be cleared and the Event added to an empty queue so that the agent can be notified that the game has ended. This method is to be called by GBU.

Parameters:

e - the event to be sent to the agent associated with this Mediator.

takeForAgent

Event takeForAgent()

Takes an Event from the queue so that the VHRunner can use the Event. This method should only be called by a VHRunner.

Returns:

the Event at the top of the queue.

clearAgentQueue

void clearAgentQueue()

Used when an Event comes in that signals the end of the game. The entire queue is cleared so that no more Events are sent to the agent.

pendingAgentEvent

public boolean pendingAgentEvent()

Called by the associated VHRunner to determine whether or not this Mediator holds an Event for it to look at.

Returns:

true if there's an Event for the VHRunner to take. False if there is not.

makeRunnable

void makeRunnable()

A method to be called by GBU to indicate that the Mediator's VHRunner can run.

stopRunning

void stopRunning()

A method to be called by GBU or the Mediator's VHRunner to indicate that the VHRunner should stop running.

isPageOpen

boolean isPageOpen()

Returns whether or not the webpage is open.

Returns:

true if the webpage is open. false if it is not.

isActivePage

boolean isActivePage()

Returns whether or not the Mediator has received a signal from the webpage recently. Called by this mediator's VHRunner after going 12 seconds without a new Event.

Returns:

true if the Mediator has had contact with the webpage in the past 12 seconds. false otherwise.

setActivePage

void setActivePage(boolean activePage)

A method to toggle the activePage field of this object. When the Mediator receives a signal from the webpage, this method is called with the argument "true." When the Mediator's VHRunner looks at activePage, this method is called with the argument "false" to reset the value. Note: This method does not simply negate activePage, because it can be called (and often is) multiple times by this and/or GBU before VHRunner looks at activePage.

Parameters:

activePage - true when called from this and/or GBU, false when called from VHRunner.