com.caplin.motif.fx.blotter.message

Class FXBlotterItemMessageFactory

java.lang.Object

com.caplin.motif.fx.blotter.message.FXBlotterItemMessageFactory

public class FXBlotterItemMessageFactory
extends Object

Instances of this class should be obtained from FXBlotterItemPublisher.getMessageFactory()

This class the capabiltiy to create the builders, that in turn are used to create the FXBlotterItemMessage, which represent a Record Message in a Blotter.

Constructor Summary

Constructors

Constructor and Description
FXBlotterItemMessageFactory(FXBlotter blotter, com.caplin.datasource.messaging.MessageFactory messageFactory) Deprecated. FXBlotterItemMessageFactory. You should not need to create instances of this class yourself. Instead it should be obtained from FXBlotterItemPublisher.getMessageFactory()

Method Summary

Modifier and Type	Method and Description
<T extends BlotterMessageBuilder> T	builderFromMessage(FXBlotterItemMessage originalMessage, String username, String itemId) Returns the builder for the FXBlotterItemMessage, which represents the Record item.
protected <T extends BlotterMessageBuilder> T	getBuilder(String username, String itemId, com.caplin.datasource.messaging.record.GenericMessage record)
<T extends BlotterMessageBuilder> T	newItemBuilder(String username, String itemId) Returns the builder for the FXBlotterItemMessage, which represents the Record Item.

Methods inherited from class java.lang.Object

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

Constructor Detail

FXBlotterItemMessageFactory

@Deprecated
public FXBlotterItemMessageFactory(FXBlotter blotter,
                                               com.caplin.datasource.messaging.MessageFactory messageFactory)

Deprecated. FXBlotterItemMessageFactory. You should not need to create instances of this class yourself. Instead it should be obtained from FXBlotterItemPublisher.getMessageFactory()

Parameters:

blotter - The object containing the record item regex.

messageFactory - The standard DataSource message factory.

Method Detail

newItemBuilder

public <T extends BlotterMessageBuilder> T newItemBuilder(String username,
                                                          String itemId)

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

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

Parameters:

username - The username pertaining to the Record Item

itemId - The id of the Record Item

Returns:

The builder, which builds the FXBlotterItemMessage

builderFromMessage

public <T extends BlotterMessageBuilder> T builderFromMessage(FXBlotterItemMessage originalMessage,
                                                              String username,
                                                              String itemId)

Returns the builder for the FXBlotterItemMessage, which represents the Record item. The builder copies and sets on itself all fields found into the passed in FXBlotterItemMessage original message.

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

Parameters:

originalMessage - The message from which all fields will be copied into the builder

username - The username pertaining to the Record Item

itemId - The id of the Record Item

Returns:

The builder, which builds the FXBlotterItemMessage

getBuilder

protected <T extends BlotterMessageBuilder> T getBuilder(String username,
                                                         String itemId,
                                                         com.caplin.datasource.messaging.record.GenericMessage record)