|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.reticular.agentBuilder.agent.perception.KqmlMessage
Description : This class encapsulates all of the information that is necessary for kqml style communication. This is the object passed to the perception system for sending to remote agents. The agent constructs KqmlMessage objects and then can pass them into the perception object for sending.
Field Summary | |
protected java.lang.Object |
_content
A reference to the content. |
protected java.lang.Class |
_contentType
The java.lang.Class object representing the content object class. |
protected java.lang.String |
_contentTypeName
The fully qualified name of the the content type. |
protected java.lang.String |
_from
When forwarding is used the from and to fields contain the important source and destination information. |
protected java.lang.String |
_inReplyTo
The string that is used in conjunction with the replyWith parameter. |
protected java.lang.String |
_language
The language field. |
protected java.lang.String |
_ontology
The ontology field. |
protected java.lang.String |
_performative
The performative. |
protected java.lang.String |
_protocol
The protocol being used with this message. |
protected java.lang.String |
_receiver
The agent name for the message receiver. |
protected java.lang.String |
_replyWith
The string that needs to be used in the reply. |
protected java.lang.String |
_sender
The agent name for the message sender. |
protected java.lang.String |
_senderURL
The agent URL for the sending agent. |
protected java.lang.String |
_sentTime
The time at which the message was sent. |
protected java.lang.String |
_to
|
Constructor Summary | |
KqmlMessage()
Description : The constructor for a message. |
Method Summary | |
java.lang.Object |
clone()
Description : Calls the super.clone() from lang.obj and catches the exceptions. |
boolean |
equals(java.lang.Object obj)
Description : Compares the current KqmlMessage object with the passed in argument on a field by field basis. |
java.lang.Object |
getContent()
Description : Return the content of the kqml message. |
java.lang.Class |
getContentType()
Description : Returns the class (a java.lang.Class object) of the content object. |
java.lang.String |
getContentTypeName()
Description : Returns the name of the content type. |
java.lang.String |
getFrom()
Description : Returns the "from" kqml field of a message. |
java.lang.String |
getInReplyTo()
Description : Gets the in-reply-to parameter |
java.lang.String |
getLanguage()
Description : Returns the language. |
java.lang.String |
getOntology()
Description : Returns the ontology. |
java.lang.String |
getPerformative()
Description : Returns the current performative. |
java.lang.String |
getProtocol()
Description : Returns the protocl. |
java.lang.String |
getReceiver()
Description : The method to return the sender agent's name. |
java.lang.String |
getReceiverName()
Deprecated. Use getReceiver |
java.lang.String |
getReplyWith()
Description : gets the replyWith parameter |
java.lang.String |
getSender()
Description : The method to return the sender agent's name. |
java.lang.String |
getSenderName()
Deprecated. User getSender |
boolean |
getSendError()
Returns the send error flag. |
java.lang.String |
getSenderURL()
Description : Return the content of the kqml message. |
java.lang.String |
getSentTime()
Description : Returns the sentTime. |
java.lang.String |
getTo()
Description : Returns the "to" kqml field of a message. |
void |
setContent(java.lang.Object newContent)
Description : Sets the content field. |
void |
setContentType(java.lang.Class newContentType)
Sets the class (a java.lang.Class object) of the content object. |
void |
setContentTypeName(java.lang.String newContentType)
Description : |
void |
setFrom(java.lang.String from)
Description : Sets the "from" kqml fiedl of a message. |
void |
setInReplyTo(java.lang.String inReplyTo)
Description : Sets the inReplyTo parameter. |
void |
setLanguage(java.lang.String language)
Description : Sets the language field. |
void |
setOntology(java.lang.String ontology)
Description : Sets the ontology field. |
void |
setPerformative(java.lang.String perf)
Description : Set the performative to whichever performative is required. |
void |
setProtocol(java.lang.String protocol)
Description : Sets the protocol field. |
void |
setReceiver(java.lang.String name)
Description : The method to set the sender agent's name. |
void |
setReceiverName(java.lang.String name)
Deprecated. Use setReceiver |
void |
setReplyWith(java.lang.String replyWith)
Description : Sets the reply-with parameter. |
void |
setSender(java.lang.String name)
Description : The method to set the sender agent's name. |
void |
setSenderName(java.lang.String name)
Deprecated. User setSender |
void |
setSendError(boolean error)
Sets the sendError flag when this message is undelivered. |
void |
setSenderURL(java.lang.String URL)
Description : The method to set the sender's URL. |
void |
setSentTime(java.lang.String sentTime)
Description : Sets the sentTime field. |
void |
setTo(java.lang.String to)
Description : Sets the "to" kqml fiedl of a message. |
java.lang.String |
toString()
Description : Return a string representation of this KQML message. |
Methods inherited from class java.lang.Object |
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected java.lang.String _performative
protected java.lang.String _sender
protected java.lang.String _senderURL
protected java.lang.String _receiver
protected java.lang.String _from
protected java.lang.String _to
protected java.lang.String _replyWith
protected java.lang.String _inReplyTo
protected java.lang.String _sentTime
protected java.lang.String _language
protected java.lang.String _ontology
protected java.lang.String _protocol
protected java.lang.Object _content
protected java.lang.Class _contentType
protected java.lang.String _contentTypeName
Constructor Detail |
public KqmlMessage()
-
- Method Detail |
public java.lang.Object clone()
clone
in class java.lang.Object
-
- public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Object
- - The object to compare for semantic equality.public void setContent(java.lang.Object newContent)
newContent
- - The content to be put in the object.
- public java.lang.Object getContent()
-
- public void setContentTypeName(java.lang.String newContentType)
newContentType
- - A class name of the content.public java.lang.String getContentTypeName()
public java.lang.Class getContentType()
public void setContentType(java.lang.Class newContentType)
newContentType
- - a java.lang.Class object representing the class of
the new content object.
- public java.lang.String getSenderURL()
-
- public void setSenderURL(java.lang.String URL)
name
- - Agent name of sender.
- public java.lang.String getSenderName()
-
- public void setSenderName(java.lang.String name)
name
- - Agent name of sender.
- public java.lang.String getSender()
-
- public void setSender(java.lang.String name)
name
- - Agent name of sender.
- public void setReceiverName(java.lang.String name)
name
- - Agent name of message receiver.
- public java.lang.String getReceiverName()
-
- public void setReceiver(java.lang.String name)
name
- - Agent name of message receiver.
- public java.lang.String getReceiver()
-
- public void setPerformative(java.lang.String perf)
perf
- = New performative.
- public java.lang.String getPerformative()
-
- public java.lang.String getOntology()
- public void setOntology(java.lang.String ontology)
String
- - The new ontology.
- public java.lang.String getLanguage()
- public void setLanguage(java.lang.String language)
String
- - The new language.
- public java.lang.String getProtocol()
- public void setProtocol(java.lang.String protocol)
String
- - The new protocol.
- public java.lang.String getSentTime()
- public void setSentTime(java.lang.String sentTime)
String
- - The new sentTime.
- public java.lang.String getReplyWith()
- public void setReplyWith(java.lang.String replyWith)
String
- - The new replyWith token.
- public java.lang.String getInReplyTo()
- public void setInReplyTo(java.lang.String inReplyTo)
String
- - The new inReplyTo token.
- public java.lang.String getTo()
-
- public void setTo(java.lang.String to)
String
- - The new "to" value.
- public java.lang.String getFrom()
-
- public void setSendError(boolean error)
boolean
- public boolean getSendError()
public void setFrom(java.lang.String from)
String
- - The new "from" value.
- public java.lang.String toString()
toString
in class java.lang.Object
-
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |