com.caplin.motif.fx.blotter.cache

Class FXCachedBlotterMessage

java.lang.Object

com.caplin.motif.fx.blotter.cache.FXCachedBlotterMessage

All Implemented Interfaces:

SendableBlotterMessage

public class FXCachedBlotterMessage
extends Object
implements SendableBlotterMessage

Instances of this class should be created using FXCachedBlotterMessageFactory.createBlotterMessage(String) or FXCachedBlotterMessageFactory.createBlotterMessage(com.caplin.motif.fx.blotter.subject.FXBlotterSubjectInfo)

Field Summary

Fields

Modifier and Type	Field and Description
protected FXBlotter	blotter
protected Map<String,ContainerAction>	containerActions
protected boolean	isImage
protected String	subject
protected String	username

Constructor Summary

Constructors

Constructor and Description
FXCachedBlotterMessage(FXBlotter blotter, FXBlotterItemMessageFactory itemFactory, String username) Deprecated. You should not need to create instances of this object. Instead use FXCachedBlotterMessageFactory.createBlotterMessage(String) or FXCachedBlotterMessageFactory.createBlotterMessage(com.caplin.motif.fx.blotter.subject.FXBlotterSubjectInfo)
FXCachedBlotterMessage(FXBlotter blotter, FXBlotterItemMessageFactory itemFactory, String username, String subject) Deprecated. You should not need to create instances of this object. Instead use FXCachedBlotterMessageFactory.createBlotterMessage(String) or FXCachedBlotterMessageFactory.createBlotterMessage(com.caplin.motif.fx.blotter.subject.FXBlotterSubjectInfo)

Method Summary

Modifier and Type	Method and Description
void	addItem(FXBlotterItemMessage message) Use newItemBuilder(String) or copyOf(MessageFactory) to create the FXBlotterItemMessage to be passed into this method.
FXCachedBlotterMessage	copyOf(com.caplin.datasource.messaging.MessageFactory factory) Creates a new Object with the same state as the this object.
FXBlotter	getBlotter() Returns the FXBlotter object that this object was instantiated with.
List<ContainerAction>	getContainerActions() A List of actions represented by ContainerAction to be performed on the Container.
List<FXBlotterItemMessage>	getMessages() Returns a list of FXBlotterItemMessage which represent the Record Messages added to this Message.
String	getSubject() The subject for this Container
String	getUsername() The username for which this Container belongs to.
boolean	isImage() Returns the value of the image flag
<T extends FXBaseBlotterItemMessage.Builder> T	newItemBuilder(String itemId) Returns the builder for the FXBlotterItemMessage, which represents the Record Item.
void	removeItem(FXBlotterItemMessage message) Removes the item from the Blotter.
void	removeItem(String itemId) Removes the item with the given ID from the Blotter.
void	setImage(boolean isImage) Sets the image flag for this Container message.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

blotter

protected final FXBlotter blotter

username

protected final String username

subject

protected String subject

isImage

protected boolean isImage

containerActions

protected final Map<String,ContainerAction> containerActions

Constructor Detail

FXCachedBlotterMessage

@Deprecated
public FXCachedBlotterMessage(FXBlotter blotter,
                                          FXBlotterItemMessageFactory itemFactory,
                                          String username)

Deprecated. You should not need to create instances of this object. Instead use FXCachedBlotterMessageFactory.createBlotterMessage(String) or FXCachedBlotterMessageFactory.createBlotterMessage(com.caplin.motif.fx.blotter.subject.FXBlotterSubjectInfo)

Creates a new instance of FXCachedBlotterMessage.

Parameters:

blotter - The blotter that the message relates to.

itemFactory - The factory that creates the blotter items.

username - The username of the user that the blotter belongs to.

FXCachedBlotterMessage

@Deprecated
public FXCachedBlotterMessage(FXBlotter blotter,
                                          FXBlotterItemMessageFactory itemFactory,
                                          String username,
                                          String subject)

Deprecated. You should not need to create instances of this object. Instead use FXCachedBlotterMessageFactory.createBlotterMessage(String) or FXCachedBlotterMessageFactory.createBlotterMessage(com.caplin.motif.fx.blotter.subject.FXBlotterSubjectInfo)

Creates a new instance of FXCachedBlotterMessage.

Parameters:

blotter - The blotter that the message relates to.

itemFactory - The factory that creates the blotter items.

username - The username of the user that the blotter belongs to.

subject - The subject of the blotter message.

Method Detail

getContainerActions

public List<ContainerAction> getContainerActions()

Description copied from interface: SendableBlotterMessage

A List of actions represented by ContainerAction to be performed on the Container.

Specified by:

getContainerActions in interface SendableBlotterMessage

Returns:

A List of actions represented by ContainerAction to be performed on the Container.

getSubject

public String getSubject()

The subject for this Container

Specified by:

getSubject in interface SendableBlotterMessage

Returns:

The subject for this Container

getUsername

public String getUsername()

Description copied from interface: SendableBlotterMessage

The username for which this Container belongs to.

Specified by:

getUsername in interface SendableBlotterMessage

Returns:

The username for which this Container belongs to.

getBlotter

public FXBlotter getBlotter()

Returns the FXBlotter object that this object was instantiated with.

Returns:

The FXBlotter item that this object was instantiated with.

isImage

public boolean isImage()

Description copied from interface: SendableBlotterMessage

Returns the value of the image flag

Specified by:

isImage in interface SendableBlotterMessage

Returns:

The value of the image flag

setImage

public void setImage(boolean isImage)

Description copied from interface: SendableBlotterMessage

Sets the image flag for this Container message. If the image flag is set to true, this message replaces any current state of the Container that has been aggregated from previous messages, and represents the new definitive state of the Container.

Specified by:

setImage in interface SendableBlotterMessage

Parameters:

isImage - True if this message should be treated as an image, or false if it represents an update.

getMessages

public List<FXBlotterItemMessage> getMessages()

Returns a list of FXBlotterItemMessage which represent the Record Messages added to this Message.

Returns:

a list FXBlotterItemMessage that are part of this cached blotter message

addItem

public void addItem(FXBlotterItemMessage message)

Use newItemBuilder(String) or copyOf(MessageFactory) to create the FXBlotterItemMessage to be passed into this method.

This method adds the specified item to the Container, at the top of the Container. If the item has already been added, then nothing will happen, it will stay in its current position.

An already added item must be first removed using removeItem(FXBlotterItemMessage), and then added in order to move to the top of the container.

Note that if the item was created with a username other than the one this object was created with, then the username will be changed to match this objects username instead.

Parameters:

message - The object representing the Record Item, to be added to this Blotter Message.

removeItem

public void removeItem(FXBlotterItemMessage message)

Removes the item from the Blotter.

Parameters:

message - The object representing the Record Item to be removed from the Blotter.

removeItem

public void removeItem(String itemId)

Removes the item with the given ID from the Blotter.

Parameters:

itemId - The id of the Record item to be removed from the Blotter.

newItemBuilder

public <T extends FXBaseBlotterItemMessage.Builder> T newItemBuilder(String itemId)

Returns the builder for the FXBlotterItemMessage, which represents the Record Item.

Specifies type T, where T extends the FXBaseBlotterItemMessage.Builder. Some examples are HistoricItemMessage.Builder, ExecutionItemMessage.Builder, ActivityItemMessage.Builder, OrderItemMessage.Builder.

Parameters:

itemId - The id of the Record Item

Returns:

The builder, which builds the FXBlotterItemMessage

copyOf

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

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

Parameters:

factory - To be used in creating the copy

Returns:

A new Object with the same state as this object.

toString

public String toString()

Overrides:

toString in class Object