AbstractCallActionManager

java.lang.Object
- org.astrogrid.samp.gui.SendActionManager
- - org.astrogrid.samp.gui.AbstractCallActionManager

Direct Known Subclasses:

IndividualCallActionManager, UniformCallActionManager
```
public abstract class AbstractCallActionManager
extends SendActionManager
```
Partial SendActionManager implementation which uses the Asynchronous Call/Response delivery pattern. It supplies most of the machinery required for tracking what happened to responses to messages sent at the same time, but does not implement the actual createBroadcastAction() method. Subclasses are provided which do this.

Since:

11 Nov 2008

Author:

Mark Taylor

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`AbstractCallActionManager.CallResponseHandler` ResponseHandler implementation for use by this class.
`private class`	`AbstractCallActionManager.SendAction` Action which performs a send to a particular client.
`private static class`	`AbstractCallActionManager.TagInfo` Aggregates information required for handling responses which correspond to a particular message tag.

Field Summary

Fields
Modifier and Type	Field and Description
`private GuiHubConnector`	`connector_`
`private static java.util.logging.Logger`	`logger_`
`private java.awt.Component`	`parent_`
`private AbstractCallActionManager.CallResponseHandler`	`responder_`

Fields inherited from class org.astrogrid.samp.gui.SendActionManager
BROADCAST_TARGET, subscribedClientModel_

Constructor Summary

Constructors
Constructor and Description
`AbstractCallActionManager(java.awt.Component parent, GuiHubConnector connector, javax.swing.ListModel clientListModel)` Constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract javax.swing.Action`	`createBroadcastAction()` Must be implemented by concrete subclasses.
`protected abstract java.util.Map`	`createMessage(Client client)` Returns the Message object which is to be transmitted by this manager to a given client.
`protected ResultHandler`	`createResultHandler(HubConnection connection, Message msg, Client[] recipients)` Returns an object which will be informed of the results of a single- or multiple-recipient send as they arrive.
`java.lang.String`	`createTag()` Creates and returns a new tag which will be attached to an outgoing message, and updates internal structures so that it will be recognised in the future.
`void`	`dispose()` Releases resources associated with this object.
`protected javax.swing.Action`	`getSendAction(Client client)` Returns an action which can perform a single-client send associated with this object.
`void`	`registerHandler(java.lang.String tag, Client[] recipients, ResultHandler handler)` Registers a result handler to handle results corresponding to a message tag.

Methods inherited from class org.astrogrid.samp.gui.SendActionManager
createSendMenu, createTargetAction, createTargetSelector, disposeSendMenu, getBroadcastAction, getBroadcastIcon, getClientListModel, getConnector, getSendIcon, setEnabled, updateState

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - parent_
```
private final java.awt.Component parent_
```
  - connector_
```
private final GuiHubConnector connector_
```
  - responder_
```
private final AbstractCallActionManager.CallResponseHandler responder_
```
  - logger_
```
private static final java.util.logging.Logger logger_
```
- Constructor Detail
  - AbstractCallActionManager
```
public AbstractCallActionManager(java.awt.Component parent,
                                 GuiHubConnector connector,
                                 javax.swing.ListModel clientListModel)
```
    Constructor.
    
    Parameters:
    
    parent - parent component
    
    connector - hub connector
    
    clientListModel - list model containing only those clients which are suitable recipients; all elements must be Clients
- Method Detail
  - createBroadcastAction
```
protected abstract javax.swing.Action createBroadcastAction()
```
    Must be implemented by concrete subclasses.
    
    Specified by:
    
    createBroadcastAction in class SendActionManager
    
    Returns:
    
    broadcast action; may be null if broadcast is not required
  - createResultHandler
```
protected ResultHandler createResultHandler(HubConnection connection,
                                            Message msg,
                                            Client[] recipients)
```
    Returns an object which will be informed of the results of a single- or multiple-recipient send as they arrive. This method will be called from the event dispatch thread.
    The default implementation returns an instance of LogResultHandler.
    
    Parameters:
    
    connection - connection object
    
    msg - the message which was sent
    
    recipients - the recipients to whom the message was sent
    
    Returns:
    
    result handler object
  - dispose
```
public void dispose()
```
    Releases resources associated with this object. Specifically, it removes listeners from the hub connector. Following a call to this method, this object should not be used again.
    
    Overrides:
    
    dispose in class SendActionManager
  - createMessage
```
protected abstract java.util.Map createMessage(Client client)
                                        throws java.lang.Exception
```
    Returns the Message object which is to be transmitted by this manager to a given client. This is called by the action returned by getSendAction(org.astrogrid.samp.Client).
    
    Parameters:
    
    client - target
    
    Returns:
    
    message
    
    Throws:
    
    java.lang.Exception
  - getSendAction
```
protected javax.swing.Action getSendAction(Client client)
```
    Description copied from class: SendActionManager
    
    Returns an action which can perform a single-client send associated with this object. If it implements equals (and hashCode) intelligently there will be efficiency advantages. The enabled status of such actions will be managed by this object.
    
    Specified by:
    
    getSendAction in class SendActionManager
    
    Parameters:
    
    client - recipient client
    
    Returns:
    
    action which sends to the given client
  - createTag
```
public java.lang.String createTag()
```
    Creates and returns a new tag which will be attached to an outgoing message, and updates internal structures so that it will be recognised in the future. A subsequent call to registerHandler(java.lang.String, org.astrogrid.samp.Client[], org.astrogrid.samp.client.ResultHandler) should be made for the returned tag.
    
    Returns:
    
    new tag
  - registerHandler
```
public void registerHandler(java.lang.String tag,
                            Client[] recipients,
                            ResultHandler handler)
```
    Registers a result handler to handle results corresponding to a message tag.
    
    Parameters:
    
    tag - tag returned by an earlier invocation of createTag()
    
    recipients - clients from which responses are expected
    
    handler - result handler for responses; may be null if no handling is required

Class AbstractCallActionManager

Nested Class Summary

Field Summary

Fields inherited from class org.astrogrid.samp.gui.SendActionManager

Constructor Summary

Method Summary

Methods inherited from class org.astrogrid.samp.gui.SendActionManager

Methods inherited from class java.lang.Object

Field Detail

parent_

connector_

responder_

logger_

Constructor Detail

AbstractCallActionManager

Method Detail

createBroadcastAction

createResultHandler

dispose

createMessage

getSendAction

createTag

registerHandler