Package edu.tufts.hrilab.action.gui

Class GoalManagerAdapter

java.lang.Object

edu.tufts.hrilab.gui.GuiAdapter

edu.tufts.hrilab.action.gui.GoalManagerAdapter

public class GoalManagerAdapter
extends GuiAdapter

A WebSocket adapter for communication between the GoalManagerImpl and the frontend Goal Manager GUI.

See Also:

• GoalManagerComponent (the corresponding GuiProvider for this adapter)

Field Summary

Fields

Modifier and Type	Field	Description
final String	ACTION_SCRIPT_PATH	Path to the folder containing all .asl files.

Fields inherited from class edu.tufts.hrilab.gui.GuiAdapter

groups, log

Constructor Summary

Constructors

Constructor	Description
GoalManagerAdapter(Collection<String> groups)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	actionAdded(ActionDBEntry adb)	Notifies the frontend of a new action to offer the user.
void	actionRemoved(ActionDBEntry adb)	Notifies the frontend to remove an action from display.
String	getPathRoot()	Enforce implementation of path root getter for getPath().
protected void	handleMessage(com.google.gson.JsonObject message)	Handle a message from the client.
protected void	init()	Initialization after construction and after TRADE services are registered.
protected boolean	providesTradeServices()	Force implementing classes to declare whether they provide TRADE services.

Methods inherited from class edu.tufts.hrilab.gui.GuiAdapter

createAndRegisterInstance, getPath, sendMessage

Methods inherited from class java.lang.Object

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

Field Details

ACTION_SCRIPT_PATH

public final String ACTION_SCRIPT_PATH

Path to the folder containing all .asl files. Depending on method of launch, might require prefix .. or might not.

See Also:

• Constant Field Values

Constructor Details

GoalManagerAdapter

public GoalManagerAdapter(Collection<String> groups)

Constructor.

Method Details

init

protected void init()

Initialization after construction and after TRADE services are registered.

Overrides:

init in class GuiAdapter

providesTradeServices

protected boolean providesTradeServices()

Force implementing classes to declare whether they provide TRADE services. This is to decide whether or not to register any new instances of that class with TRADE.

Specified by:

providesTradeServices in class GuiAdapter

Returns:

true iff the adapter provides TRADE services.

handleMessage

protected void handleMessage(com.google.gson.JsonObject message)

Handle a message from the client.

Overrides:

handleMessage in class GuiAdapter

Parameters:

message - a JsonObject representing the message.

getPathRoot

public String getPathRoot()

Enforce implementation of path root getter for getPath(). This is usually based on the component's/adapter's name; e.g., the belief GUI's path root is belief.

Specified by:

getPathRoot in class GuiAdapter

Returns:

the path root as a String.

actionAdded

public void actionAdded(ActionDBEntry adb)

Notifies the frontend of a new action to offer the user. Called when an action is added to the database.

Parameters:

adb - the new ActionDBEntry

actionRemoved

public void actionRemoved(ActionDBEntry adb)

Notifies the frontend to remove an action from display. Called when an action is removed from the database.

Parameters:

adb - the removed ActionDBEntry