casa.testAgents

Class ChatMessage

java.lang.Object

casa.testAgents.ChatMessage

public class ChatMessage
extends Object

ChatMessage is a simple class that is used to store one chat message that has been recieved by a ChatAgent. It is usually used in a Vector containing several messages, and the toString() function is designed to be used in JLists and other visual interfaces.

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.

Version:

0.9

Author:

Jason Heard,Rob Kremer

See Also:

ChatAgent

Field Summary

Fields

Modifier and Type	Field and Description
private URLDescriptor	cd Stores the URLDescriptor of the cooperation domain that this message was sent through.
private boolean	directed Determines whether this message was a "directed" message.
private String	message Stores the actual text of the chat message.
private Vector<URLDescriptor>	recipients Stores a Vector containing the recipients (URLDescriptors) of the message.
private URLDescriptor	sender Stores the URLDescriptor of the sender of the message.
private boolean	whisper Determines whether this message was a "whisper".

Constructor Summary

Constructors

Constructor and Description
ChatMessage(MLMessage message, URLDescriptor cd) Creates a new ChatMessage from the given MLMessage and the given cooperation domain.
ChatMessage(String message, URLDescriptor sender, URLDescriptor cd) Creates a new ChatMessage that is not a "directed" message or a "whisper" with the given message text, sender, and cooperation domain.

Method Summary

Modifier and Type	Method and Description
URLDescriptor	getCD() Retrieves the cooperation domain of the chat message.
String	getMessage() Retrieves the actual text of the chat message.
Vector	getRecipients() Retrieves the list of recipients of the message, or null if the message is not "directed".
URLDescriptor	getSender() Retrieves the sender of the chat message as a URLDescriptor.
boolean	isDirected() Retrieves whether the message is "directed".
boolean	isWhisper() Retrieves whether the message is a "whisper".
void	setCD(URLDescriptor cd) Sets the cooperation domain of the chat message.
void	setDirected(Vector<URLDescriptor> recipients) Sets the message so that it is "directed" with the specified recipients.
void	setMessage(String message) Sets the actual text of the chat message.
void	setRecipients(Vector<URLDescriptor> recipients) Sets the list of recipients of the message.
void	setSender(URLDescriptor sender) Sets the sender of the chat message as a URLDescriptor.
void	setWhisper(Vector<URLDescriptor> recipients) Sets the message so that it is a "whisper" with the specified exclusive recipients.
String	toString() Returns the chat message as a string suitable to use in a user interface.
void	unsetDirected() Sets the message so that it is not "directed".
void	unsetWhisper() Sets the message so that it is not a "whisper".

Methods inherited from class java.lang.Object

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

Field Detail

message

private String message

Stores the actual text of the chat message.

sender

private URLDescriptor sender

Stores the URLDescriptor of the sender of the message.

directed

private boolean directed

Determines whether this message was a "directed" message. It is true if the message was directed to one or more specified agents; false otherwise.

whisper

private boolean whisper

Determines whether this message was a "whisper". It is true if the message was sent exclusivly to one or more specified agents; false otherwise. This can only be true if the message is "directed".

recipients

private Vector<URLDescriptor> recipients

Stores a Vector containing the recipients (URLDescriptors) of the message. This is null if the message is not "directed".

cd

private URLDescriptor cd

Stores the URLDescriptor of the cooperation domain that this message was sent through.

Constructor Detail

ChatMessage

public ChatMessage(String message,
                   URLDescriptor sender,
                   URLDescriptor cd)

Creates a new ChatMessage that is not a "directed" message or a "whisper" with the given message text, sender, and cooperation domain.

Parameters:

message - The actual text of the chat message.

sender - The URLDescriptor of the sender of the message.

cd - The URLDescriptor of the cooperation domain that this message was sent through.

ChatMessage

public ChatMessage(MLMessage message,
                   URLDescriptor cd)

Creates a new ChatMessage from the given MLMessage and the given cooperation domain. The details of the message are arll retrieved from the MLMessage.

Parameters:

message - An MLMessage containing both the actual text of the message, the sender of the message, whether the message is a "directed" message or a "whisper", and who the message was to if it was "directed".

cd - The URLDescriptor of the cooperation domain that this message was sent through.

Method Detail

getMessage

public String getMessage()

Retrieves the actual text of the chat message.

Returns:

The actual text of the chat message.

setMessage

public void setMessage(String message)

Sets the actual text of the chat message.

Parameters:

message - The actual text of the chat message.

getSender

public URLDescriptor getSender()

Retrieves the sender of the chat message as a URLDescriptor.

Returns:

The sender of the chat message as a URLDescriptor.

setSender

public void setSender(URLDescriptor sender)

Sets the sender of the chat message as a URLDescriptor.

Parameters:

sender - The sender of the chat message as a URLDescriptor.

isDirected

public boolean isDirected()

Retrieves whether the message is "directed". Returns true if the message was directed to one or more specified agents; false otherwise.

Returns:

true if the message was directed to one or more specified agents; false otherwise.

isWhisper

public boolean isWhisper()

Retrieves whether the message is a "whisper". Returns true if the message was sent exclusivly to one or more specified agents; false otherwise.

Returns:

true if the message was sent exclusivly to one or more specified agents; false otherwise.

setDirected

public void setDirected(Vector<URLDescriptor> recipients)

Sets the message so that it is "directed" with the specified recipients.

Parameters:

recipients - A Vector containing the recipients (URLDescriptors) of the message.

unsetDirected

public void unsetDirected()

Sets the message so that it is not "directed". In addition, the message is set so that is is not a "whisper" and recipients is set to null.

setWhisper

public void setWhisper(Vector<URLDescriptor> recipients)

Sets the message so that it is a "whisper" with the specified exclusive recipients. In addition, the message is set so that it is "directed".

Parameters:

recipients - A Vector containing the exclusive recipients (URLDescriptors) of the message.

unsetWhisper

public void unsetWhisper()

Sets the message so that it is not a "whisper".

getRecipients

public Vector getRecipients()

Retrieves the list of recipients of the message, or null if the message is not "directed".

Returns:

A Vector containing the recipients (URLDescriptors) of the message, or null if the message is not "directed".

setRecipients

public void setRecipients(Vector<URLDescriptor> recipients)

Sets the list of recipients of the message. If the message is not "directed", nothing will be changed.

Parameters:

recipients - A Vector containing the recipients (URLDescriptors) of the message.

getCD

public URLDescriptor getCD()

Retrieves the cooperation domain of the chat message.

Returns:

The cooperation domain of the chat message.

setCD

public void setCD(URLDescriptor cd)

Sets the cooperation domain of the chat message.

Parameters:

cd - The cooperation domain of the chat message.

toString

public String toString()

Returns the chat message as a string suitable to use in a user interface. This string can be formatted in several ways, depending on whether the sender and recipient or recipients are known or not, whether the message is directed or a whisper, and how many recipients there are:

if the message is not directed and the sender is known: "sender: message", if the message is not directed and the sender is not known: "<unknown sender>: message", if the message is directed, the sender is known, and the recipient or recipients are unknown: "sender-><unknown>: message", if the message is directed, the sender is not known, and the recipient or recipients are unknown: "<unknown sender>-><unknown>: message", if the message is directed, the sender is known, and there is one known recipient: "sender->recipient: message", if the message is directed, the sender is not known, and there is one known recipient: "<unknown sender>->recipient: message", if the message is directed, the sender is known, and there are more than one known recipient: "sender->(recipient, recipient, ...): message", if the message is directed, the sender is not known, and there are more than one known recipient: "<unknown sender>->(recipient, recipient, ...): message", if the message is a whisper, the sender is known, and the recipient or recipients are unknown: "sender-><unknown>: (* message *)", if the message is a whisper, the sender is not known, and the recipient or recipients are unknown: "<unknown sender>-><unknown>: (* message *)", if the message is a whisper, the sender is known, and there is one known recipient: "sender->recipient: (* message *)", if the message is a whisper, the sender is not known, and there is one known recipient: "<unknown sender>->recipient: (* message *)", if the message is a whisper, the sender is known, and there are more than one known recipient: "sender->(recipient, recipient, ...): (* message *)", if the message is a whisper, the sender is not known, and there are more than one known recipient: "<unknown sender>->(recipient, recipient, ...): (* message *)",

Overrides:

toString in class Object

Returns:

The chat message as a string suitable to use in a user interface.