com.caplin.motif.fx.blotter.message

Class FXBlotterMessageFactory

java.lang.Object

com.caplin.motif.fx.blotter.message.FXBlotterMessageFactory

public class FXBlotterMessageFactory
extends Object

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

This class has the capability to create the FXBlotterMessage, which represents the Container message, with its constituent items, but not the data for those items.

Field Summary

Fields

Modifier and Type	Field and Description
protected FXBlotter	blotter
protected com.caplin.datasource.messaging.MessageFactory	factory

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
FXBlotterMessage	createBlotterMessage(FXBlotterSubjectInfo subjectInfo) Creates the FXBlotterMessage which represents the Container for the blotter belonging to the user and blotter subject defined in the FXBlotterSubjectInfo specified.
FXBlotterMessage	createBlotterMessage(String username) Creates the FXBlotterMessage which represents the Container for the blotter belonging to the specified user.
com.caplin.datasource.messaging.MessageFactory	getMessageFactory() Returns the standard DataSource MessageFactory which allows you to create ContainerMessage and RecordMessage should you need to.

Methods inherited from class java.lang.Object

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

Field Detail

blotter

protected final FXBlotter blotter

factory

protected final com.caplin.datasource.messaging.MessageFactory factory

Constructor Detail

FXBlotterMessageFactory

@Deprecated
public FXBlotterMessageFactory(FXBlotter blotter,
                                           com.caplin.datasource.messaging.MessageFactory factory)

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

Parameters:

blotter - The object containing the Container subject regex, and the Record Item subject regex for that container.

factory - The standard DataSource message factory.

Method Detail

getMessageFactory

public com.caplin.datasource.messaging.MessageFactory getMessageFactory()

Returns the standard DataSource MessageFactory which allows you to create ContainerMessage and RecordMessage should you need to. In most cases using createBlotterMessage(String) and createBlotterMessage(FXBlotterSubjectInfo) should suffice.

Returns:

The standard DataSource message factory

createBlotterMessage

public FXBlotterMessage createBlotterMessage(String username)

Creates the FXBlotterMessage which represents the Container for the blotter belonging to the specified user.

After creating the item FXBlotterMessage.addItem(String) or FXBlotterMessage.addItem(FXBlotter, String) should be called to add the subjects for the records that are the constituents of the Blotter.

If the request was for a container with filter parameters use createBlotterMessage(FXBlotterSubjectInfo) instead

Parameters:

username - The username for which the blotter belongs to

Returns:

The object representing the empty Container message.

createBlotterMessage

public FXBlotterMessage createBlotterMessage(FXBlotterSubjectInfo subjectInfo)

Creates the FXBlotterMessage which represents the Container for the blotter belonging to the user and blotter subject defined in the FXBlotterSubjectInfo specified.

After creating the item FXBlotterMessage.addItem(String) or FXBlotterMessage.addItem(FXBlotter, String) should be called to add the subjects for the records that are the constituents of the Blotter.

Use this callback if you are servicing a request containing filter parameters.

Parameters:

subjectInfo - The object representing the blotter request and its parameters.

Returns:

The object representing the empty Container message.