com.caplin.motif.fx.blotter

Class FXBlotter

java.lang.Object

com.caplin.motif.fx.blotter.FXBlotter

Direct Known Subclasses:

ActivityBlotter, ExecutionBlotter, HistoricBlotter, OrderBlotter

public abstract class FXBlotter
extends Object

Base class for blotter subject data. An instance of this class contains the blotter container and item subject regex. It is also able to create blotter container and item subjects for a given username.

You only need to create your own subclass of FXBlotter if your application has departed from the subjects used for the standard four blotters in the FX Motif, or if you want to add your own blotter. If you are using the standard FX Motif blotters, rather than creating your own subclass of FXBlotter you can simply use one of the four existing subclasses:

• ACTIVITY
• EXECUTION
• HISTORIC
• ORDER

Field Summary

Fields

Modifier and Type	Field and Description
static FXBlotter	ACTIVITY The FXBlotter for the Activity blotter, which holds the regex for the Activity blotter container subject and its constituents.
static FXBlotter	EXECUTION The FXBlotter for the Execution blotter, which holds the regex for the Execution blotter container subject and its constituents.
static FXBlotter	HISTORIC The FXBlotter for the Historic blotter, which holds the regex for the Historic blotter container subject and its constituents.
static FXBlotter	ORDER The FXBlotter for the Order blotter, which holds the regex for the Order blotter container subject and its constituents.

Constructor Summary

Constructors

Constructor and Description
FXBlotter(String containerRegex, String itemRegex, String containerSuffix, String itemSuffix) Constructs the FXBlotter with the given regex's and subject suffixes.

Method Summary

Methods

Modifier and Type	Method and Description
String	decodeItemId(String id) Decodes the item ID using UTF-8 URL encoding.
protected String	encodeItemId(String id) Applies UTF-8 URL encoding to the provided ID.
String	getBlotterContainerRegex() Returns the blotter container regex, used in parsing/recognising blotter container requests.
String	getBlotterItemRegex() Returns the blotter record item regex, used in parsing/recognising blotter record item requests.
String	getBlotterItemSubject(String username, String itemId) Returns the string representing the blotter record item subject with the given username, and id.
String	getBlotterSubject(String username) Returns the string representing the blotter container subject with the given user name.
abstract BlotterMessageBuilder	newItemBuilder(String username, String itemId, com.caplin.datasource.messaging.record.GenericMessage record) Deprecated. Use FXBlotterItemMessageFactory.newItemBuilder(String, String) or FXCachedBlotterMessage.newItemBuilder(String) instead.

Methods inherited from class java.lang.Object

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

Field Detail

ACTIVITY

public static final FXBlotter ACTIVITY

The FXBlotter for the Activity blotter, which holds the regex for the Activity blotter container subject and its constituents.

EXECUTION

public static final FXBlotter EXECUTION

The FXBlotter for the Execution blotter, which holds the regex for the Execution blotter container subject and its constituents.

HISTORIC

public static final FXBlotter HISTORIC

The FXBlotter for the Historic blotter, which holds the regex for the Historic blotter container subject and its constituents.

ORDER

public static final FXBlotter ORDER

The FXBlotter for the Order blotter, which holds the regex for the Order blotter container subject and its constituents.

Constructor Detail

FXBlotter

public FXBlotter(String containerRegex,
         String itemRegex,
         String containerSuffix,
         String itemSuffix)

Constructs the FXBlotter with the given regex's and subject suffixes.

Parameters:

containerRegex - The Container subject regex

itemRegex - The regex for the Record constituents of the Container

containerSuffix - The suffix to be used when constructing a container subject

itemSuffix - The suffix to be used when constructing a constituent record item subject

Method Detail

getBlotterContainerRegex

public String getBlotterContainerRegex()

Returns the blotter container regex, used in parsing/recognising blotter container requests.

Returns:

The container request regex.

getBlotterItemRegex

public String getBlotterItemRegex()

Returns the blotter record item regex, used in parsing/recognising blotter record item requests.

Returns:

The record item request regex.

getBlotterSubject

public String getBlotterSubject(String username)

Returns the string representing the blotter container subject with the given user name.

Parameters:

username - The username to be used as part of the container subject.

Returns:

The blotter container subject

getBlotterItemSubject

public String getBlotterItemSubject(String username,
                           String itemId)

Returns the string representing the blotter record item subject with the given username, and id. An id should uniquely identify the record item, from other items. Examples of such id's are trade id's, order id's or request id's.

Parameters:

username - The username to be used as part of the record item subject.

itemId - The id to be used as part of the record item subject

Returns:

The blotter record item subject

encodeItemId

protected String encodeItemId(String id)

Applies UTF-8 URL encoding to the provided ID.

Parameters:

id - The ID to encode.

Returns:

An encoded version of the ID.

Throws:

RuntimeException - If your JVM does not support the UTF-8 encoding.

decodeItemId

public String decodeItemId(String id)

Decodes the item ID using UTF-8 URL encoding.

Parameters:

id - The ID to be decoded.

Returns:

The decoded ID.

Throws:

RuntimeException - If your JVM does not support the UTF-8 encoding.

newItemBuilder

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

Deprecated. Use FXBlotterItemMessageFactory.newItemBuilder(String, String) or FXCachedBlotterMessage.newItemBuilder(String) instead.

Creates a new builder for blotter item messages.

Parameters:

username - The username that the message relates to.

itemId - The ID of the blotter item.

record - The record that the message should be sent on.

Returns:

A builder for creating the blotter item messages.