GoalViewerAdapter (DIARC)

java.lang.Object

edu.tufts.hrilab.gui.GuiAdapter

edu.tufts.hrilab.action.gui.GoalViewerAdapter

public class GoalViewerAdapter extends GuiAdapter

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

See Also:

GoalManagerComponent (the GuiProvider for this adapter)

Field Summary

Fields inherited from class edu.tufts.hrilab.gui.GuiAdapter
groups, log
Constructor Summary

Constructors

Constructor

Description

GoalViewerAdapter(Collection<String> groups)

Constructor.
Method Summary

Modifier and Type

Method

Description

String

getPathRoot()

Enforce implementation of path root getter for getPath().

void

handleGoalNotification(GoalInfo info)

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

Constructor Details
- GoalViewerAdapter
  
  public GoalViewerAdapter(Collection<String> groups)
  
  Constructor.
Method Details
- handleGoalNotification
  
  public void handleGoalNotification(GoalInfo info) throws ai.thinkingrobots.trade.TRADEException
  
  Throws:
  
  ai.thinkingrobots.trade.TRADEException
- 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.