Conversation

java.lang.Object
- casa.conversation2.BoundSymbolObject
- - casa.conversation2.Conversation

All Implemented Interfaces:

Cloneable, Comparable<Conversation>

Direct Known Subclasses:

SubscribeClientConversation, SubscribeServerConversation
```
public class Conversation
extends BoundSymbolObject
implements Comparable<Conversation>
```
Author:

Rob Kremer

Nested Class Summary
- Nested classes/interfaces inherited from class casa.conversation2.BoundSymbolObject
  BoundSymbolObject.Symbols

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) TransientAgent`	`agent`
`private static CasaLispOperator`	`CONVERSATION` (Conversation ...)
`private static CasaLispOperator`	`CONVERSATION__EXECUTE_ACTION` Lisp operator: (conversation.set-state) Sets the state of the current specified
`private static CasaLispOperator`	`CONVERSATION__GET_STATE` Lisp operator: (conversation.get-state) Gets the state of the conversation specified
`private static CasaLispOperator`	`CONVERSATION__SET_ACTION` Lisp operator: (conversation.set-state) Sets the state of the current specified
`private static CasaLispOperator`	`CONVERSATION__SET_STATE` Lisp operator: (conversation.set-state) Sets the state of the current specified
`private Action`	`failureAction`
`private String`	`id`
`static Conversations`	`knownConversations` All conversations known in the current process -- not necessarily supported by any agent in the process.
`ReentrantLock`	`lock`
`private PolicyContainer`	`policies` The list of all policies for the Conversation
`(package private) String`	`sourceFile`
`private Action`	`successAction`

Fields inherited from class casa.conversation2.BoundSymbolObject
children, name, symbols

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Conversation(String name)` Creates a top-level conversation template.
	`Conversation(String name, Conversation parent)` Creates a child conversation template.
`protected`	`Conversation(String name, TransientAgent ownerAgent, MLMessage message, Pair<String,Object>... bindings)` Constructor for a conversation instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addChild(BoundSymbolObject child)` Add a child to the child conversation list
`void`	`addPolicy(AbstractPolicy policy)`
`void`	`addSubConversation(Conversation conv)` adds a conversation as a sub conversation to this one
`protected StatusObject<List<Object>>`	`applyPolicies(Event event)` ***Warning: It's not very efficient to call this method.
`void`	`bindVar(String sym, Object val)` This method adds two functionalities to `BoundSymbolObject.bindVar(String, Object)`: if sym is "STATE" and val is "terminated", queue this conversation for deletion.
`void`	`bindVarExpression(String sym, LispObject exp)` Create a local binding for this symbols sym.
`void`	`bindVarTo(String sym, String parentSym)` Bind the value of sym to the parent's local symbol sym.
`int`	`compareTo(Conversation o)`
`protected BoundSymbolObject`	`copyTo(BoundSymbolObject x)`
`private static int`	`count(Boolean... b)`
`protected void`	`deleteSelf()`
`void`	`destroy()` Desperate attempt to get the gc to clear objects when we think this one is dead.
`static Conversation`	`findConversation(String conv)`
`Vector<Pair<Conversation,AbstractPolicy>>`	`getApplicablePolicies(PolicyAgentInterface agent, Event event)` Note that there is not "isApplicable(Event)" method in this class.
`Conversation`	`getChild(String childName)`
`Collection<Conversation>`	`getChildConversations()`
`String`	`getId()`
`static Collection<Conversation>`	`getKnownConversations()`
`protected Conversation`	`getParent()`
`PolicyContainer`	`getPolicies()` getter method for the conversation's policies
`String`	`getSourceFile()`
`String`	`getState()`
`Map<String,LispObject>`	`getSymbolMap()`
`Object`	`getVar(String sym)` Resolve the value of symbols sym.
`Conversation`	`instantiate(TransientAgent ownerAgent, MessageEvent event, Object overRideSuccessHandler, Object overRideFailureHandler)`
`private void`	`instantiateHelper(TransientAgent ownerAgent, MessageEvent event, Conversation template)` fix up all the children (that have already been cloned by `BoundSymbolObject.clone()`) evaluates symbols sets the state to "init"
`boolean`	`isTemplate()`
`void`	`setName(String newName)`
`protected void`	`setParent(Conversation parent)`
`protected void`	`setSourceFile(String sourceFile)`
`void`	`setState(String state)` Conversation state
`String`	`toString()`
`String`	`toString(int indent, boolean brief)`

Methods inherited from class casa.conversation2.BoundSymbolObject
bindValue, bindVarTo, clearChildren, clone, extendEnv, getChildren, getMap, getName, setParent

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

- Field Detail
  - agent
```
TransientAgent agent
```
  - lock
```
public ReentrantLock lock
```
  - policies
```
private PolicyContainer policies
```
    The list of all policies for the Conversation
  - successAction
```
private Action successAction
```
  - failureAction
```
private Action failureAction
```
  - knownConversations
```
public static Conversations knownConversations
```
    All conversations known in the current process -- not necessarily supported by any agent in the process.
  - id
```
private String id
```
  - CONVERSATION
```
private static final CasaLispOperator CONVERSATION
```
    (Conversation ...)
  - CONVERSATION__SET_STATE
```
private static final CasaLispOperator CONVERSATION__SET_STATE
```
    Lisp operator: (conversation.set-state)
    Sets the state of the current specified
  - CONVERSATION__SET_ACTION
```
private static final CasaLispOperator CONVERSATION__SET_ACTION
```
    Lisp operator: (conversation.set-state)
    Sets the state of the current specified
  - CONVERSATION__EXECUTE_ACTION
```
private static final CasaLispOperator CONVERSATION__EXECUTE_ACTION
```
    Lisp operator: (conversation.set-state)
    Sets the state of the current specified
  - sourceFile
```
String sourceFile
```
  - CONVERSATION__GET_STATE
```
private static final CasaLispOperator CONVERSATION__GET_STATE
```
    Lisp operator: (conversation.get-state)
    Gets the state of the conversation specified
- Constructor Detail
  - Conversation
```
public Conversation(String name)
```
    Creates a top-level conversation template.
    
    Parameters:
    
    name -
  - Conversation
```
public Conversation(String name,
                    Conversation parent)
```
    Creates a child conversation template.
    
    Parameters:
    
    name -
    
    parent -
  - Conversation
```
protected Conversation(String name,
                       TransientAgent ownerAgent,
                       MLMessage message,
                       Pair<String,Object>... bindings)
                throws IllegalOperationException
```
    Constructor for a conversation instance. This constructor is protected because it should only be called from instantiate(TransientAgent, MessageEvent, Object, Object), which is the correct way to instantiate a conversation instance from a conversation template.
    
    Parameters:
    
    name - the name of the lisp function defining the type of conversation we want
    
    ownerAgent - the name of the registered agent that wants to have this conversation
    
    message - the constructed KQML message containing the relevant data
    
    bindings - string object pairs (Ex. ,['to',URL] and ['from',URL] information)
    
    Throws:
    
    IllegalOperationException
- Method Detail
  - findConversation
```
public static Conversation findConversation(String conv)
```
    Parameters:
    
    conv - the name of the conversation to return.
    
    Returns:
    
    Either the conversation if it's in knownConversations, or null if the named conv can't be found.
  - getKnownConversations
```
public static Collection<Conversation> getKnownConversations()
```
    Returns:
    
    The list of all conversations in knownConversations.
  - getId
```
public String getId()
```
  - setName
```
public void setName(String newName)
```
    Overrides:
    
    setName in class BoundSymbolObject
  - setState
```
public void setState(String state)
```
    Conversation state
  - deleteSelf
```
protected void deleteSelf()
```
  - getVar
```
public Object getVar(String sym)
              throws IllegalOperationException
```
    Description copied from class: BoundSymbolObject
    
    Resolve the value of symbols sym. It may be locally bound or may be bound to a symbol in the parent's symbols (not necessarily of the same name).
    
    Overrides:
    
    getVar in class BoundSymbolObject
    
    Throws:
    
    IllegalOperationException - if the sym is not evaluated
  - bindVar
```
public void bindVar(String sym,
                    Object val)
```
    This method adds two functionalities to BoundSymbolObject.bindVar(String, Object):
    - if sym is "STATE" and val is "terminated", queue this conversation for deletion.
    - adds a debugging trace.
    Overrides:
    
    bindVar in class BoundSymbolObject
    
    Parameters:
    
    sym - the symbol to bind
    
    val - the object to bind to sym
    
    See Also:
    
    BoundSymbolObject.bindVar(java.lang.String, java.lang.Object)
  - bindVarExpression
```
public void bindVarExpression(String sym,
                              LispObject exp)
```
    Description copied from class: BoundSymbolObject
    
    Create a local binding for this symbols sym.
    
    Overrides:
    
    bindVarExpression in class BoundSymbolObject
  - bindVarTo
```
public void bindVarTo(String sym,
                      String parentSym)
               throws IllegalOperationException
```
    Description copied from class: BoundSymbolObject
    
    Bind the value of sym to the parent's local symbol sym.
    
    Overrides:
    
    bindVarTo in class BoundSymbolObject
    
    Throws:
    
    IllegalOperationException - if childName isn't the name of a child of this conversation
  - getState
```
public String getState()
```
  - instantiate
```
public Conversation instantiate(TransientAgent ownerAgent,
                                MessageEvent event,
                                Object overRideSuccessHandler,
                                Object overRideFailureHandler)
                         throws IllegalOperationException
```
    Throws:
    
    IllegalOperationException
  - copyTo
```
protected BoundSymbolObject copyTo(BoundSymbolObject x)
                            throws CloneNotSupportedException
```
    Overrides:
    
    copyTo in class BoundSymbolObject
    
    Throws:
    
    CloneNotSupportedException
  - instantiateHelper
```
private void instantiateHelper(TransientAgent ownerAgent,
                               MessageEvent event,
                               Conversation template)
                        throws IllegalOperationException
```
    - fix up all the children (that have already been cloned by BoundSymbolObject.clone())
    - evaluates symbols
    - sets the state to "init"
    Parameters:
    
    ownerAgent -
    
    event -
    
    template -
    
    Throws:
    
    IllegalOperationException
  - setParent
```
protected void setParent(Conversation parent)
```
  - getParent
```
protected Conversation getParent()
```
    Overrides:
    
    getParent in class BoundSymbolObject
  - addChild
```
protected void addChild(BoundSymbolObject child)
```
    Description copied from class: BoundSymbolObject
    
    Add a child to the child conversation list
    
    Overrides:
    
    addChild in class BoundSymbolObject
  - getChild
```
public Conversation getChild(String childName)
```
    Overrides:
    
    getChild in class BoundSymbolObject
    
    Returns:
    
    The child with the name childName or null if there is no such child
  - getChildConversations
```
public Collection<Conversation> getChildConversations()
```
  - isTemplate
```
public boolean isTemplate()
```
    Returns:
    
    true iff this conversation is a template conversation (ie: agent==null).
  - addPolicy
```
public void addPolicy(AbstractPolicy policy)
```
  - addSubConversation
```
public void addSubConversation(Conversation conv)
```
    adds a conversation as a sub conversation to this one
    
    Parameters:
    
    conv - the conversation to add as a child of this conversation
  - getApplicablePolicies
```
public Vector<Pair<Conversation,AbstractPolicy>> getApplicablePolicies(PolicyAgentInterface agent,
                                                                       Event event)
```
    Note that there is not "isApplicable(Event)" method in this class. This is because this is an expensive operation that throws away a lot of effort that could be used by applyPolicies(Event), so the information should be cached as in the following pattern: ... Vector < AbstractPolicy > applicable = conv.getApplicablePolicies(event); if (applicable!=null) result = conv.applyPolicies(event,applicable); ...
    Parameters: event - Returns: a Vector (in no particular order) or all the policies applicable to the event, including any in any sub-conversations (children).
  getPolicies public PolicyContainer getPolicies() getter method for the conversation's policies Returns: the policies that define the conversation's behaviour applyPolicies protected StatusObject<List<Object>> applyPolicies(Event event) throws Exception ***Warning: It's not very efficient to call this method. In general, callers will be checking to see if policies are applicable first which is expensive, so the caller should cache in information by doing it this way: ... Vector < AbstractPolicy > applicable = conv.getApplicablePolicies(event); if (applicable!=null) result = applyPolicies(event,applicable); ... Parameters: event - Returns: Throws: Exception getSymbolMap public Map<String,LispObject> getSymbolMap() Returns: the symbol-to-value map for this conversations toString public String toString() Overrides: toString in class Object toString public String toString(int indent, boolean brief) compareTo public int compareTo(Conversation o) Specified by: compareTo in interface Comparable<Conversation> destroy public void destroy() Desperate attempt to get the gc to clear objects when we think this one is dead. Overrides: destroy in class BoundSymbolObject count private static int count(Boolean... b) setSourceFile protected void setSourceFile(String sourceFile) getSourceFile public String getSourceFile()

Class Conversation

Nested Class Summary

Nested classes/interfaces inherited from class casa.conversation2.BoundSymbolObject

Field Summary

Fields inherited from class casa.conversation2.BoundSymbolObject

Constructor Summary

Method Summary

Methods inherited from class casa.conversation2.BoundSymbolObject

Methods inherited from class java.lang.Object

Field Detail

agent

lock

policies

successAction

failureAction

knownConversations

id

CONVERSATION

CONVERSATION__SET_STATE

CONVERSATION__SET_ACTION

CONVERSATION__EXECUTE_ACTION

sourceFile

CONVERSATION__GET_STATE

Constructor Detail

Conversation

Conversation

Conversation

Method Detail

findConversation

getKnownConversations

getId

setName

setState

deleteSelf

getVar

bindVar

bindVarExpression

bindVarTo

getState

instantiate

copyTo

instantiateHelper

setParent

getParent

addChild

getChild

getChildConversations

isTemplate

addPolicy

addSubConversation

getApplicablePolicies

getPolicies

applyPolicies

getSymbolMap

toString

toString

compareTo

destroy

count

setSourceFile

getSourceFile