com.caplin.motif.fx.rates

Class AbstractSubjectInfo

java.lang.Object

com.caplin.motif.fx.rates.AbstractSubjectInfo

All Implemented Interfaces:

SubjectInfo

Direct Known Subclasses:

FXSubjectInfo, MetalSubjectInfo

public abstract class AbstractSubjectInfo
extends Object
implements SubjectInfo

Abstract parent class that provides an implementation of SubjectInfo with common functions shared by the subclasses FXSubjectInfo and MetalSubjectInfo.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSubjectInfo(String subject, String subjectPrefix, String baseCurrency, String termCurrency, String amountIn, String tenor, String amount, String marginBand) Constructs an AbstractSubjectInfo based on the provided subscription parameters.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Two AbstractSubjectInfo instances are equal if they have the same value for:
String	getAmount() Returns the amount for the subscription, specified as a quantity of the unit returned by getAmount().
String	getAmountIn() Returns the unit that the amount returned by getAmount() is specified in.
String	getBaseCurrency() Returns the base currency for the subscription.
String	getBrokenDate() The settlement date, if request was for a broken date.
String	getCurrencyPair() Returns the currency pair for the subscription.
String	getMarginBand() Returns the margin band for the subscription.
String	getSubject() Returns the original subject that was parsed to create this SubjectInfo
String	getSubjectPrefix() Returns the prefix from the start of the subject, for example "/FX".
String	getTenor() Returns the tenor for the subscription.
String	getTermCurrency() Returns the term currency for the subscription.
int	hashCode() Two AbstractSubjectInfo instances have the same hash code if they have the same values for:
abstract boolean	isMetal() Abstract method that indicates whether this class represents a metal subscription or not.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractSubjectInfo

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

Constructs an AbstractSubjectInfo based on the provided subscription parameters.

Parameters:

subjectPrefix - A string such as "/FX".

baseCurrency - The first currency in the currency pair. For example if the currency pair is "GBPUSD" the base currency is "GBP".

termCurrency - The second currency in the currency pair. For example if the currency pair is "GBPUSD" the base currency is "USD".

amountIn - The currency or unit that the amount is specified in. For example, in an FX rates subscription for "GBPUSD", the unit of the amount could be either "GBP" or "USD". This is typically referred to as the "dealt currency". For a precious metals subscription, the unit of the amount could be something like OZT or Kilos.

tenor - The tenor for the subscription.

amount - The amount for the subscription, specified as a quantity of the amountIn unit. Useful for volume banding.

marginBand - The margin band for the subscription. Sometimes referred to as the price tier.

Method Detail

isMetal

public abstract boolean isMetal()

Abstract method that indicates whether this class represents a metal subscription or not.

Returns:

True if this class represents a metal subscription, otherwise false.

getCurrencyPair

public String getCurrencyPair()

Returns the currency pair for the subscription.

Returns:

The currency pair in the format <base currency><term currency>. For example, if the base currency is "GBP" and the term currency is "USD" this method will return the string "GBPUSD".

getBaseCurrency

public String getBaseCurrency()

Returns the base currency for the subscription.

Returns:

The base currency for the subscription, which is the first currency in the pair.

getTermCurrency

public String getTermCurrency()

Returns the term currency for the subscription.

Returns:

The term currency for the subscription, which is the second currency in the pair.

getTenor

public String getTenor()

Returns the tenor for the subscription.

Returns:

The tenor.

getBrokenDate

public String getBrokenDate()

The settlement date, if request was for a broken date. Returns null otherwise.

Returns:

The settlement date, if request was for a broken date.

getAmountIn

public String getAmountIn()

Returns the unit that the amount returned by getAmount() is specified in. For an FX rate subscription this will be one of the two currencies in the pair, known usually as the "dealt currency". For a precious metals subscription this will return a unit such as OZT or Kilos.

Returns:

The unit that the amount is specified in.

getAmount

public String getAmount()

Returns the amount for the subscription, specified as a quantity of the unit returned by getAmount(). Generally used for determining which volume-banded price the subscription should be provided with.

Returns:

The amount for the subscription.

getMarginBand

public String getMarginBand()

Returns the margin band for the subscription. Sometimes referred to as the price tier. This is usually mapped on to the request by Liberator using the permissioning system rather than specified by the client, because clients are usually not in control of (or aware of) which price tier they have been assigned to.

Returns:

The margin band.

getSubjectPrefix

public String getSubjectPrefix()

Returns the prefix from the start of the subject, for example "/FX".

Returns:

The subject prefix.

getSubject

public String getSubject()

Description copied from interface: SubjectInfo

Returns the original subject that was parsed to create this SubjectInfo

Specified by:

getSubject in interface SubjectInfo

Returns:

The original subject.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Two AbstractSubjectInfo instances have the same hash code if they have the same values for:

• getSubjectPrefix()
• getBaseCurrency()
• getTermCurrency()
• getAmount()
• getAmountIn()
• getTenor()
• getMarginBand()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Two AbstractSubjectInfo instances are equal if they have the same value for:

• getSubjectPrefix()
• getBaseCurrency()
• getTermCurrency()
• getAmount()
• getAmountIn()
• getTenor()
• getMarginBand()

Overrides:

equals in class Object