com.caplin.motif.fx.rates

Class MetalSubjectParser

java.lang.Object

com.caplin.motif.fx.rates.AbstractSubjectParser<MetalSubjectInfo>

com.caplin.motif.fx.rates.MetalSubjectParser

All Implemented Interfaces:

SubjectParser<MetalSubjectInfo>

public class MetalSubjectParser
extends AbstractSubjectParser<MetalSubjectInfo>

Implementation of SubjectParser that parses subscription parameters into a domain object representing a subscription to streaming rates for precious metals.

Field Summary

Fields inherited from class com.caplin.motif.fx.rates.AbstractSubjectParser

subjectPattern

Constructor Summary

Constructors

Constructor and Description
MetalSubjectParser() Creates a MetalSubjectParser with the default metal subject prefix "/PM".
MetalSubjectParser(String extraSubjectPrefix) Creates a MetalSubjectParser with the default prefix "PM" plus an extra part of the subject prefix.

Method Summary

Methods

Modifier and Type	Method and Description
protected MetalSubjectInfo	createSubjectInfo(String subject, String subjectPrefix, String baseCurrency, String termCurrency, String amountIn, String tenor, String amount, String marginBand) Creates an instance of the subclass of AbstractSubjectInfo that this class has been genericised with.
com.caplin.datasource.namespace.Namespace	getNamespace() Returns the namespace handled by the subject parser.

Methods inherited from class com.caplin.motif.fx.rates.AbstractSubjectParser

getSubjectRegex, parse, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

MetalSubjectParser

public MetalSubjectParser()

Creates a MetalSubjectParser with the default metal subject prefix "/PM".

MetalSubjectParser

public MetalSubjectParser(String extraSubjectPrefix)

Creates a MetalSubjectParser with the default prefix "PM" plus an extra part of the subject prefix.

Parameters:

extraSubjectPrefix - An extra string to append to the default prefix. For example, if you pass in "EXCHANGE1" then the subject prefix for MetalSubjectInfo objects created by this parser will be set to "PM/EXCHANGE1".

Method Detail

createSubjectInfo

protected MetalSubjectInfo createSubjectInfo(String subject,
                                 String subjectPrefix,
                                 String baseCurrency,
                                 String termCurrency,
                                 String amountIn,
                                 String tenor,
                                 String amount,
                                 String marginBand)

Description copied from class: AbstractSubjectParser

Creates an instance of the subclass of AbstractSubjectInfo that this class has been genericised with.

Specified by:

createSubjectInfo in class AbstractSubjectParser<MetalSubjectInfo>

Parameters:

subject - The full subject.

subjectPrefix - A string prefix, e.g "/FX".

baseCurrency - The first currency in the pair.

termCurrency - The second currency in the pair.

amountIn - The unit that the amount is specified in. This could be the dealt currency for an instance of FXSubjectInfo or a unit such as OZT or Kilos for MetalSubjectInfo, for example.

tenor - The tenor for the subject info.

amount - The amount for the subject info, specified in the unit defined by the amountIn parameter.

marginBand - The margin band for the subject info, sometimes referred to as the price tier.

Returns:

The instance of the subclass of AbstractSubjectInfo that this class has been genericised with.

getNamespace

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

Description copied from interface: SubjectParser

Returns the namespace handled by the subject parser.

Returns:

the namespace.