com.caplin.motif.fx.blotter.message

Class FXBlotterItemMessage

java.lang.Object

com.caplin.motif.fx.blotter.message.FXBlotterItemMessage

Direct Known Subclasses:

FXBaseBlotterItemMessage

public class FXBlotterItemMessage
extends Object

An instance of this class represents a Record Item, in a Container.

Instances of this class should be created in on of two ways, this is determined by whether or not you are using the FXBlotterPublisher or the FXCachedBlotterPublisher

If you have the FXBlotterPublisher, then you must use a corresponding FXBlotterItemPublisher. You may then obtain the message factory FXBlotterItemPublisher.getMessageFactory() which will return you an instance of FXBlotterItemMessageFactory, on which you should invoke FXBlotterItemMessageFactory.newItemBuilder(String, String) to obtain the builder for this class.

If you have the FXCachedBlotterPublisher. You should obtain the message factory FXCachedBlotterPublisher.getMessageFactory(), which creates the FXCachedBlotterMessage. On the message object you should then invoke FXCachedBlotterMessage.newItemBuilder(String) to obtain the builder for this class.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	itemId
protected com.caplin.datasource.messaging.record.GenericMessage	record
protected String	username

Constructor Summary

Constructors

Constructor and Description
FXBlotterItemMessage(String username, String itemId, com.caplin.datasource.messaging.record.GenericMessage record) Deprecated. You should not need to create instances of this class yourself. Please refer to the class javadoc to see how instances of this class should be obtained.

Method Summary

Modifier and Type	Method and Description
FXBlotterItemMessage	copyOf(com.caplin.datasource.messaging.MessageFactory factory) Creates a new object with the same state as this object.
String	getField(String fieldName) Returns a field that has been set on this message with the given name.
List<com.caplin.datasource.messaging.Field>	getFields() Returns all the fields that have been set on this object as a list.
String	getItemID() Returns the item id, which will be part of the Record Item's subject
com.caplin.datasource.messaging.record.GenericMessage	getRecord() Returns the underlying DataSource message object
String	getUsername() Returns the username, which will be part of the Record Item's subject
boolean	isImage() Returns true if the this message is to be an image update
void	setImage(boolean isImage) Sets the image flag on the outgoing Record
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

record

protected final com.caplin.datasource.messaging.record.GenericMessage record

username

protected final String username

itemId

protected final String itemId

Constructor Detail

FXBlotterItemMessage

@Deprecated
public FXBlotterItemMessage(String username,
                                        String itemId,
                                        com.caplin.datasource.messaging.record.GenericMessage record)

Deprecated. You should not need to create instances of this class yourself. Please refer to the class javadoc to see how instances of this class should be obtained.

Method Detail

setImage

public void setImage(boolean isImage)

Sets the image flag on the outgoing Record

Parameters:

isImage - The image flag to be set on the Record.

isImage

public boolean isImage()

Returns true if the this message is to be an image update

Returns:

The image flag on the record

getRecord

public com.caplin.datasource.messaging.record.GenericMessage getRecord()

Returns the underlying DataSource message object

Returns:

The underlying DataSource message object

getItemID

public String getItemID()

Returns the item id, which will be part of the Record Item's subject

Returns:

The item id

getUsername

public String getUsername()

Returns the username, which will be part of the Record Item's subject

Returns:

The username

getField

public String getField(String fieldName)

Returns a field that has been set on this message with the given name.

Parameters:

fieldName - The name of the field

Returns:

The value belonging to the field with the given name.

getFields

public List<com.caplin.datasource.messaging.Field> getFields()

Returns all the fields that have been set on this object as a list.

Returns:

a list of all the fields that have been set on this object.

copyOf

public FXBlotterItemMessage copyOf(com.caplin.datasource.messaging.MessageFactory factory)

Creates a new object with the same state as this object.

Parameters:

factory - The factory to be used in creating the FXBlotterItemMessage

Returns:

A new object with the same state as this object.

toString

public String toString()

Overrides:

toString in class Object