com.caplin.motif.datasource

Interface SubjectParser<T extends SubjectInfo>

Type Parameters:

T - The Type of SubjectInfo that this parser returns.

All Known Implementing Classes:

AbstractSubjectParser, AllocationViewSubjectParser, FXBlotterItemSubjectParser, FXBlotterSubjectParser, FXSubjectParser, MetalSubjectParser, OrderDetailsSubjectParser, SalesOrderDetailsSubjectParser

public interface SubjectParser<T extends SubjectInfo>

A SubjectParser validates and parses subject requests into Domain objects; these objects provide methods which return the information contained in the request.

See Also:

FXSubjectInfo

Method Summary

Modifier and Type	Method and Description
com.caplin.datasource.namespace.Namespace	getNamespace() Returns the namespace handled by the subject parser.
String	getSubjectRegex() Deprecated. This method is deprecated and scheduled for removal. It was only called by the library if you made use of the FXOrdersAdapter.registerStrategyDetailsRequestListenerFactory(com.caplin.motif.fx.trading.orders.details.StrategyDetailsRequestListenerFactory, SubjectParser) method, which has also been deprecated.
T	parse(String subject) Returns the domain object that represents the subject request.

Method Detail

parse

T parse(String subject)
 throws SubjectParserException

Returns the domain object that represents the subject request.

Parameters:

subject - The subject to parse.

Returns:

The domain object.

Throws:

SubjectParserException - If the subject is not in the correct format

getSubjectRegex

@Deprecated
String getSubjectRegex()

Deprecated.

This method is deprecated and scheduled for removal.

It was only called by the library if you made use of the FXOrdersAdapter.registerStrategyDetailsRequestListenerFactory(com.caplin.motif.fx.trading.orders.details.StrategyDetailsRequestListenerFactory, SubjectParser) method, which has also been deprecated.

Returns the regular expression used by this parser to parse a subject.

Returns:

subjects regular expression.

getNamespace

com.caplin.datasource.namespace.Namespace getNamespace()

Returns the namespace handled by the subject parser.

Returns:

the namespace.