triana.types.clipins

Class MessageClipIn

java.lang.Object

triana.types.clipins.MessageClipIn

All Implemented Interfaces:

java.io.Serializable, ClipIn

public class MessageClipIn
extends java.lang.Object
implements ClipIn

MessageClipIn is an Object containing three Strings: a message, the name of the sender of the message, and the name of the intended recipient of the message. It is designed to allow units to pass information along a processing network from one to another. The sender and recipient are expected to be units, and the Strings should identify them. These can be class names or other names known to units using this ClipIn. All of the Strings can be altered by any Units that receive the ClipIn using methods provided here. If the recipient field is left as the empty String, then any receiving Unit may assume that the message is intended for it.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MessageClipIn() Constructs an empty MessageClipIn.
MessageClipIn(java.lang.String text, java.lang.String from) Constructs a MessageClipIn with no recipient.
MessageClipIn(java.lang.String text, java.lang.String from, java.lang.String to) Constructs a MessageClipIn with a recipient.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Clones the ClipIn to an identical one.
void	finalizeAttach(AttachInfo info) This method is called when the clip-in is removed from a task's clip-in bucket.
java.lang.String	getMessage() Returns the current message.
java.lang.String	getRecipient() Returns the current recipient.
java.lang.String	getSender() Returns the current sender.
void	initializeAttach(AttachInfo info) This method is called before the clip-in enters a task's clip-in bucket.
void	setMessage(java.lang.String text) Sets the message.
void	setRecipient(java.lang.String to) Sets the recipient.
void	setSender(java.lang.String from) Sets the sender.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageClipIn

public MessageClipIn()

Constructs an empty MessageClipIn.

MessageClipIn

public MessageClipIn(java.lang.String text,
             java.lang.String from)

Constructs a MessageClipIn with no recipient.

Parameters:

text - The message being sent

from - The sender of the message

MessageClipIn

public MessageClipIn(java.lang.String text,
             java.lang.String from,
             java.lang.String to)

Constructs a MessageClipIn with a recipient.

Parameters:

text - The message being sent

from - The sender of the message

to - The intended recipient of the message

Method Detail

initializeAttach

public void initializeAttach(AttachInfo info)

This method is called before the clip-in enters a task's clip-in bucket. This occurs when either the data it is attached to is input by the task, or when the unit directly adds the clip-in to its bucket.

Specified by:

initializeAttach in interface ClipIn

Parameters:

info - info about the task the clip-in is being attached to

finalizeAttach

public void finalizeAttach(AttachInfo info)

This method is called when the clip-in is removed from a task's clip-in bucket. This occurs when either the data it is attached to is output by the task, or when the unit directly remove the clip-in from its bucket.

Specified by:

finalizeAttach in interface ClipIn

Parameters:

info - info about the task the clip-in is being removed from

clone

public java.lang.Object clone()

Clones the ClipIn to an identical one. This is a copy by value, not by reference. This method must be implemented for each class in a way that depends on the contents of the ClipIn.

Specified by:

clone in interface ClipIn

Overrides:

clone in class java.lang.Object

Returns:

a copy by value of the current ClipIn

setMessage

public void setMessage(java.lang.String text)

Sets the message.

Parameters:

text - The new value of the message

setSender

public void setSender(java.lang.String from)

Sets the sender.

Parameters:

from - The new value of the sender

setRecipient

public void setRecipient(java.lang.String to)

Sets the recipient.

Parameters:

to - The new value of the recipient

getMessage

public java.lang.String getMessage()

Returns the current message.

Returns:

String The current message

getSender

public java.lang.String getSender()

Returns the current sender.

Returns:

String The current sender

getRecipient

public java.lang.String getRecipient()

Returns the current recipient.

Returns:

String The current recipient