zeus.concepts
Class Performative

java.lang.Object
  zeus.concepts.Performative

Direct Known Subclasses:

FIPAPerformative

public class Performative

extends java.lang.Object

The Performative class provides a standard data structure for inter-agent messaging. The message format and available message types have been derived from the FIPA Agent Communication Language description.

This class contains methods that allow the attributes of performative objects to be set and modified, although typically developers will only need to invoke one of the constructors. More information on performatives and the communication mechanism is provided in the Zeus Technical Manual.

Field Summary

static java.lang.String[]	ATTRIBUTE_TYPES
protected java.lang.String	content
private static int	CONTENT
private static int	CONVERSATION_ID
protected java.lang.String	conversationId
protected java.util.Hashtable	envelope
private static int	IN_REPLY_TO
protected java.lang.String	inReplyTo
protected java.lang.String	language
private static int	LANGUAGE
static java.lang.String[]	MESSAGE_TYPES
static java.lang.String[]	MESSAGE_TYPES_UPPER
protected java.lang.String	ontology
private static int	ONTOLOGY
protected java.lang.String	protocol
private static int	PROTOCOL
private static int	RECEIVER
protected HSet	receivers
private static int	REPLY_BY
private static int	REPLY_TO
private static int	REPLY_WITH
protected java.lang.String	replyBy
protected java.lang.String	replyTo
protected java.lang.String	replyWith
(package private) java.lang.StringBuffer	sb
protected java.lang.String	sender
private static int	SENDER
protected java.lang.String	type
private static int	TYPE

Constructor Summary

Performative()

Performative(Performative perf)

Performative(java.lang.String type)

Method Summary

Address	getAddress()
java.lang.Object	getAttribute(java.lang.String attribute)
java.lang.String	getContent()
java.lang.String	getConversationId()
java.util.Hashtable	getEnvelope()
java.lang.Object	getEnvelopeItem(java.lang.String name)
java.lang.String	getInReplyTo()
java.lang.String	getLanguage()
java.lang.String	getOntology()
java.lang.String	getProtocol()
java.lang.String	getReceiver()
java.util.Enumeration	getReceivers()
Time	getReceiveTime()
java.lang.String	getReplyBy()
java.lang.String	getReplyTo()
java.lang.String	getReplyWith()
java.lang.String	getSender()
Time	getSendTime()
java.lang.String	getType()
boolean	isValid()
void	send(AgentContext context)
void	setAddress(Address value)
void	setAttribute(java.lang.String attribute, java.lang.Object value)
void	setContent(java.lang.String value)
void	setConversationId(java.lang.String value)
void	setEnvelope(java.util.Hashtable input)
void	setEnvelopeItem(java.lang.String name, java.lang.Object item)
void	setInReplyTo(java.lang.String value)
void	setLanguage(java.lang.String value)
void	setOntology(java.lang.String value)
void	setProtocol(java.lang.String value)
void	setReceiver(java.lang.String value)
void	setReceivers(java.util.Enumeration enum)
void	setReceivers(HSet input)
void	setReceivers(java.util.Vector input)
void	setReceiveTime(Time value)
void	setReplyBy(java.lang.String value)
void	setReplyTo(java.lang.String value)
void	setReplyWith(java.lang.String value)
void	setSender(java.lang.String value)
void	setSendTime(Time value)
void	setType(java.lang.String type)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_TYPES

public static final java.lang.String[] MESSAGE_TYPES

MESSAGE_TYPES_UPPER

public static final java.lang.String[] MESSAGE_TYPES_UPPER

ATTRIBUTE_TYPES

public static final java.lang.String[] ATTRIBUTE_TYPES

TYPE

private static final int TYPE

See Also:

Constant Field Values

SENDER

private static final int SENDER

See Also:

Constant Field Values

RECEIVER

private static final int RECEIVER

See Also:

Constant Field Values

CONTENT

private static final int CONTENT

See Also:

Constant Field Values

REPLY_WITH

private static final int REPLY_WITH

See Also:

Constant Field Values

IN_REPLY_TO

private static final int IN_REPLY_TO

See Also:

Constant Field Values

REPLY_BY

private static final int REPLY_BY

See Also:

Constant Field Values

ONTOLOGY

private static final int ONTOLOGY

See Also:

Constant Field Values

LANGUAGE

private static final int LANGUAGE

See Also:

Constant Field Values

PROTOCOL

private static final int PROTOCOL

See Also:

Constant Field Values

CONVERSATION_ID

private static final int CONVERSATION_ID

See Also:

Constant Field Values

REPLY_TO

private static final int REPLY_TO

See Also:

Constant Field Values

type

protected java.lang.String type

sender

protected java.lang.String sender

receivers

protected HSet receivers

content

protected java.lang.String content

replyWith

protected java.lang.String replyWith

inReplyTo

protected java.lang.String inReplyTo

replyBy

protected java.lang.String replyBy

ontology

protected java.lang.String ontology

language

protected java.lang.String language

protocol

protected java.lang.String protocol

conversationId

protected java.lang.String conversationId

envelope

protected java.util.Hashtable envelope

replyTo

protected java.lang.String replyTo

sb

java.lang.StringBuffer sb

Constructor Detail

Performative

public Performative()

Performative

public Performative(java.lang.String type)

Performative

public Performative(Performative perf)

Method Detail

setType

public void setType(java.lang.String type)

setSender

public void setSender(java.lang.String value)

setReceiver

public void setReceiver(java.lang.String value)

setReplyWith

public void setReplyWith(java.lang.String value)

setInReplyTo

public void setInReplyTo(java.lang.String value)

setReplyBy

public void setReplyBy(java.lang.String value)

setReplyTo

public void setReplyTo(java.lang.String value)

setOntology

public void setOntology(java.lang.String value)

setLanguage

public void setLanguage(java.lang.String value)

setContent

public void setContent(java.lang.String value)

setProtocol

public void setProtocol(java.lang.String value)

setConversationId

public void setConversationId(java.lang.String value)

setReceivers

public void setReceivers(java.util.Vector input)

setReceivers

public void setReceivers(HSet input)

setReceivers

public void setReceivers(java.util.Enumeration enum)

setAddress

public void setAddress(Address value)

setSendTime

public void setSendTime(Time value)

setReceiveTime

public void setReceiveTime(Time value)

setEnvelopeItem

public void setEnvelopeItem(java.lang.String name,
                            java.lang.Object item)

getEnvelopeItem

public java.lang.Object getEnvelopeItem(java.lang.String name)

setEnvelope

public void setEnvelope(java.util.Hashtable input)

getEnvelope

public java.util.Hashtable getEnvelope()

getType

public java.lang.String getType()

getSender

public java.lang.String getSender()

getReplyWith

public java.lang.String getReplyWith()

getInReplyTo

public java.lang.String getInReplyTo()

getReplyBy

public java.lang.String getReplyBy()

getReplyTo

public java.lang.String getReplyTo()

getOntology

public java.lang.String getOntology()

getLanguage

public java.lang.String getLanguage()

getContent

public java.lang.String getContent()

getProtocol

public java.lang.String getProtocol()

getConversationId

public java.lang.String getConversationId()

getReceiver

public java.lang.String getReceiver()

getReceivers

public java.util.Enumeration getReceivers()

getAddress

public Address getAddress()

getSendTime

public Time getSendTime()

getReceiveTime

public Time getReceiveTime()

isValid

public boolean isValid()

toString

public final java.lang.String toString()

getAttribute

public java.lang.Object getAttribute(java.lang.String attribute)

setAttribute

public void setAttribute(java.lang.String attribute,
                         java.lang.Object value)

send

public void send(AgentContext context)