PerformDescriptor

java.lang.Object
- casa.Status
- - casa.PerformDescriptor

All Implemented Interfaces:

Cloneable, Map<String,String>
```
public class PerformDescriptor
extends Status
implements Map<String,String>
```
Title: CASA Agent Infrastructure

Description:
PerformDescriptor is a meant to be a simple description consisting of key/value pairs. It is an extension of Status with TreeMap properties added.
PerformDescriptor is usually used to return information from an agent processing a message. The policies call callback methods to allow the agent to process the message appropriately (if at all), and use the information returned in the PerformDescriptor to modify behaviour. For example, if a reply is normally called for, the type of the reply will be modified depending on the Status object in the returned PerformDescriptor, but the key/value pairs always override whatever the "normative" key/value pairs in any reply message.
In addition you can add a Condition which will indicate that the associated performance/action should be delayed until the condition is satisfied (note that this is newer addtion, so it might be neglected by older code).
Copyright: Copyright 2003-2014, Knowledge Science Group, University of Calgary. Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. The Knowledge Science Group makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

Company: Knowledge Science Group, University of Calgary

Version:

0.9

Author:

kremer

See Also:

TreeMap, Status

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary

Fields
Modifier and Type	Field and Description
`private TreeMap<String,String>`	`params`
`private static CasaLispOperator`	`PERFORMDESCRIPTOR` Lisp operator: (PERFORMDESCRIPTOR ...) Sends the designated response to
`private static CasaLispOperator`	`PERFORMDESCRIPTOR__GET_STATUS` Lisp operator: (PERFORMDESCRIPTOR.GET-STATUS PD ...) Sends the designated response to
`private static CasaLispOperator`	`PERFORMDESCRIPTOR__GET_STATUS_VALUE` Lisp operator: (PERFORMDESCRIPTOR.GET-STATUS-VALUE PD ...) Sends the designated response to
`private static CasaLispOperator`	`PERFORMDESCRIPTOR__GET_VALUE` Lisp operator: (PERFORMDESCRIPTOR.GET-VALUE PD KEY ...) Sends the designated response to
`private static CasaLispOperator`	`PERFORMDESCRIPTOR__OVERLAY` Lisp operator: (PERFORMDESCRIPTOR.OVERLAY PD &allow-other-keys) Conditionally overlays the `PerformDescriptor` PD by the other-keys.
`private Status`	`status` This seems odd, but this allows PerformDescriptor to "absorb" a different subtype (eg: `StatusObject`) as it's internal structure.

Fields inherited from class casa.Status
BAD_CONTENT_FIELD, BAD_REPLY_TO_FIELD, EXCEPTION_CAUGHT, SUCCESS, TIMEOUT, UNEXEPCTED_EXCEPTION_CAUGHT, UNKNOWN_ERROR, UNKNOWN_REPLY, UNKNOWN_WARNING

Constructor Summary

Constructors
Constructor and Description
`PerformDescriptor()` Equivalent to `PerformDescriptor(null)`
`PerformDescriptor(int value)`
`PerformDescriptor(int value, String explanation)`
`PerformDescriptor(ParamsMap map)`
`PerformDescriptor(PerformDescriptor other)` Copy Constructor.
`PerformDescriptor(Status status)` Constructs a new PerformDescriptor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`Object`	`clone()`
`String`	`codeToString()` a function to convert the variable representation of a status in code to a string
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`Set<Map.Entry<String,String>>`	`entrySet()`
`void`	`fromString_extension(TokenParser parser)` To be overridden by subclasses to read any additional information from a string.
`void`	`fromString(TokenParser parser)`
`String`	`get(Object key)`
`String`	`getExplanation()`
`Status`	`getStatus()`
`int`	`getStatusValue()`
`boolean`	`isEmpty()`
`Set<String>`	`keySet()`
`PerformDescriptor`	`overlay(PerformDescriptor other, TransientAgent agent)` overlay this PerformDescriptor over the argument PerformDescriptor conditionally.
`String`	`put(String key, String value)`
`void`	`putAll(Map<? extends String,? extends String> m)`
`String`	`remove(Object key)`
`void`	`setExplanation(String explanation)`
`PerformDescriptor`	`setStatus(int val, String explanation)`
`PerformDescriptor`	`setStatus(Status status)`
`void`	`setStatusValue(int val)`
`int`	`size()`
`String`	`toString()` other methods
`Collection<String>`	`values()`

Methods inherited from class casa.Status
fromString, fromString2, main, toString_extension

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

- Field Detail
  - status
```
private Status status
```
    This seems odd, but this allows PerformDescriptor to "absorb" a different subtype (eg: StatusObject) as it's internal structure.
  - params
```
private TreeMap<String,String> params
```
  - PERFORMDESCRIPTOR
```
private static final CasaLispOperator PERFORMDESCRIPTOR
```
    Lisp operator: (PERFORMDESCRIPTOR ...)
    Sends the designated response to
  - PERFORMDESCRIPTOR__OVERLAY
```
private static final CasaLispOperator PERFORMDESCRIPTOR__OVERLAY
```
    Lisp operator: (PERFORMDESCRIPTOR.OVERLAY PD &allow-other-keys)
    Conditionally overlays the PerformDescriptor PD by the other-keys. "Conditionally" means:
    1. If the key is prefixed by a star (eg: ":*PERFORMATIVE agree") then it will only fill the key in PD if there is no such key in PD.
    2. Otherwise, for the :PERFORMATIVE and :ACT keys (only): if the value in the key subsumes the value in PD then the PD key is left; otherwise the PD key is replaced and a warning is issued to the agent's log.
    3. Otherwise the key value replaces the value in PD.
  - PERFORMDESCRIPTOR__GET_STATUS_VALUE
```
private static final CasaLispOperator PERFORMDESCRIPTOR__GET_STATUS_VALUE
```
    Lisp operator: (PERFORMDESCRIPTOR.GET-STATUS-VALUE PD ...)
    Sends the designated response to
  - PERFORMDESCRIPTOR__GET_VALUE
```
private static final CasaLispOperator PERFORMDESCRIPTOR__GET_VALUE
```
    Lisp operator: (PERFORMDESCRIPTOR.GET-VALUE PD KEY ...)
    Sends the designated response to
  - PERFORMDESCRIPTOR__GET_STATUS
```
private static final CasaLispOperator PERFORMDESCRIPTOR__GET_STATUS
```
    Lisp operator: (PERFORMDESCRIPTOR.GET-STATUS PD ...)
    Sends the designated response to
- Constructor Detail
  - PerformDescriptor
```
public PerformDescriptor()
```
    Equivalent to PerformDescriptor(null)
  - PerformDescriptor
```
public PerformDescriptor(Status status)
```
    Constructs a new PerformDescriptor.
    
    Parameters:
    
    status - a new Status, if status is null, then it will be taken as new Status(0) (a success status).
  - PerformDescriptor
```
public PerformDescriptor(int value)
```
  - PerformDescriptor
```
public PerformDescriptor(int value,
                         String explanation)
```
  - PerformDescriptor
```
public PerformDescriptor(PerformDescriptor other)
```
    Copy Constructor.
    
    Parameters:
    
    other - another Perform Descriptor, if status is null, then it will be taken as the default Constructor.} (a success status).
  - PerformDescriptor
```
public PerformDescriptor(ParamsMap map)
```
- Method Detail
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Status
  - getStatus
```
public Status getStatus()
```
    Returns:
    
    the internal Status object
  - setStatus
```
public PerformDescriptor setStatus(Status status)
```
    Parameters:
    
    status - object to become the new internal status object
    
    Returns:
    
    int new internal status object
  - setStatus
```
public PerformDescriptor setStatus(int val,
                                   String explanation)
```
    Overrides:
    
    setStatus in class Status
    
    Parameters:
    
    val - a value to be used to create a new internal status object
    
    explanation - the explanation to be used to create a new internal status object
    
    Returns:
    
    the new internal status object
  - toString
```
public String toString()
```
    Description copied from class: Status
    
    other methods
    
    Overrides:
    
    toString in class Status
  - fromString
```
public void fromString(TokenParser parser)
                throws Exception
```
    Overrides:
    
    fromString in class Status
    
    Throws:
    
    Exception
  - fromString_extension
```
public void fromString_extension(TokenParser parser)
                          throws Exception
```
    Description copied from class: Status
    
    To be overridden by subclasses to read any additional information from a string. This method is called just before Status.fromString() would read the closing ')'. This implementation does nothing.
    
    Overrides:
    
    fromString_extension in class Status
    
    Throws:
    
    ParseException
    
    Exception
  - overlay
```
public PerformDescriptor overlay(PerformDescriptor other,
                                 TransientAgent agent)
```
    overlay this PerformDescriptor over the argument PerformDescriptor conditionally.
    
    Parameters:
    
    other -
    
    agent - the Agent to use in isa comparisons.
    
    Returns:
    
    a new PerformDescritor that is the overlay result.
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<String,String>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<String,String>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<String,String>
  - entrySet
```
public Set<Map.Entry<String,String>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<String,String>
  - get
```
public String get(Object key)
```
    Specified by:
    
    get in interface Map<String,String>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<String,String>
  - keySet
```
public Set<String> keySet()
```
    Specified by:
    
    keySet in interface Map<String,String>
  - put
```
public String put(String key,
                  String value)
```
    Specified by:
    
    put in interface Map<String,String>
  - putAll
```
public void putAll(Map<? extends String,? extends String> m)
```
    Specified by:
    
    putAll in interface Map<String,String>
  - remove
```
public String remove(Object key)
```
    Specified by:
    
    remove in interface Map<String,String>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<String,String>
  - values
```
public Collection<String> values()
```
    Specified by:
    
    values in interface Map<String,String>
  - codeToString
```
public String codeToString()
```
    Description copied from class: Status
    
    a function to convert the variable representation of a status in code to a string
    
    Overrides:
    
    codeToString in class Status
    
    Returns:
    
    the string representation of the status variable
  - getExplanation
```
public String getExplanation()
```
    Overrides:
    
    getExplanation in class Status
    
    Returns:
  - getStatusValue
```
public int getStatusValue()
```
    Overrides:
    
    getStatusValue in class Status
  - setExplanation
```
public void setExplanation(String explanation)
```
    Overrides:
    
    setExplanation in class Status
  - setStatusValue
```
public void setStatusValue(int val)
```
    Overrides:
    
    setStatusValue in class Status

Class PerformDescriptor

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class casa.Status

Constructor Summary

Method Summary

Methods inherited from class casa.Status

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

status

params

PERFORMDESCRIPTOR

PERFORMDESCRIPTOR__OVERLAY

PERFORMDESCRIPTOR__GET_STATUS_VALUE

PERFORMDESCRIPTOR__GET_VALUE

PERFORMDESCRIPTOR__GET_STATUS

Constructor Detail

PerformDescriptor

PerformDescriptor

PerformDescriptor

PerformDescriptor

PerformDescriptor

PerformDescriptor

Method Detail

clone

getStatus

setStatus

setStatus

toString

fromString

fromString_extension

overlay

clear

containsKey

containsValue

entrySet

get

isEmpty

keySet

put

putAll

remove

size

values

codeToString

getExplanation

getStatusValue

setExplanation

setStatusValue