Package org.drip.state.identifier

Class FXLabel

java.lang.Object
org.drip.state.identifier.FXLabel
All Implemented Interfaces:
LatentStateLabel
public class FXLabel
extends java.lang.Object
implements LatentStateLabel
FXLabel contains the Identifier Parameters referencing the Latent State of the named FX Curve. Currently it only contains the FX Code. Currently it only contains the Sovereign Name. It provides the following functionality:
  • Make a Standard FX Label from the Currency Pair Instance
  • Make a Standard FX Label from the Currency Pair Code
  • FXLabel Constructor
  • Delegate the Inverse FX Label
  • Retrieve the Currency Pair Instance

Module Product Core Module
Library Fixed Income Analytics
Project Latent State Inference and Creation Utilities
Package Latent State Identifier Labels
Author:
Lakshmi Krishnamurthy

  • Constructor Summary

    Constructors
    Constructor Description
    FXLabel​(CurrencyPair currencyPair)
    FXLabel Constructor

  • Method Summary

    Modifier and Type Method Description
    CurrencyPair currencyPair()
    Retrieve the Currency Pair Instance
    java.lang.String fullyQualifiedName()
    Retrieve the Fully Qualified Name
    FXLabel inverse()
    Delegate the Inverse FX Label
    boolean match​(LatentStateLabel latentStateLabelOther)
    Indicate whether this Label matches the supplied.
    static FXLabel Standard​(java.lang.String code)
    Make a Standard FX Label from the Currency Pair Code
    static FXLabel Standard​(CurrencyPair currencyPair)
    Make a Standard FX Label from the Currency Pair Instance

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • FXLabel

      public FXLabel​(CurrencyPair currencyPair) throws java.lang.Exception
      FXLabel Constructor
      Parameters:
      currencyPair - The Currency Pair
      Throws:
      java.lang.Exception - Thrown if the inputs are invalid

  • Method Details

    • Standard

      public static final FXLabel Standard​(CurrencyPair currencyPair)
      Make a Standard FX Label from the Currency Pair Instance
      Parameters:
      currencyPair - The Currency Pair Instance
      Returns:
      The FX Label

    • Standard

      public static final FXLabel Standard​(java.lang.String code)
      Make a Standard FX Label from the Currency Pair Code
      Parameters:
      code - The FX Code
      Returns:
      The FX Label

    • fullyQualifiedName

      public java.lang.String fullyQualifiedName()
      Description copied from interface: LatentStateLabel
      Retrieve the Fully Qualified Name
      Specified by:
      fullyQualifiedName in interface LatentStateLabel
      Returns:
      The Fully Qualified Name

    • match

      public boolean match​(LatentStateLabel latentStateLabelOther)
      Description copied from interface: LatentStateLabel
      Indicate whether this Label matches the supplied.
      Specified by:
      match in interface LatentStateLabel
      Parameters:
      latentStateLabelOther - The Supplied Label
      Returns:
      TRUE - The Supplied Label matches this.

    • inverse

      public FXLabel inverse()
      Delegate the Inverse FX Label
      Returns:
      The Inverse FX Label

    • currencyPair

      public CurrencyPair currencyPair()
      Retrieve the Currency Pair Instance
      Returns:
      The Underlying Currency Pair Instance