Package org.drip.state.identifier

Class PaydownLabel

java.lang.Object
org.drip.state.identifier.PaydownLabel
All Implemented Interfaces:
LatentStateLabel
public class PaydownLabel
extends java.lang.Object
implements LatentStateLabel
PaydownLabel contains the Identifier Parameters referencing the Latent State of the named Pay-down Curve. Currently it only contains the Reference Entity Name. It provides the following functionality:
  • Make a Standard Pay-down Label from the Reference Entity Name
  • PaydownLabel Constructor

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
    PaydownLabel​(java.lang.String referenceEntity)
    PaydownLabel constructor

  • Method Summary

    Modifier and Type Method Description
    java.lang.String fullyQualifiedName()
    Retrieve the Fully Qualified Name
    boolean match​(LatentStateLabel latentStateLabelOther)
    Indicate whether this Label matches the supplied.
    static PaydownLabel Standard​(java.lang.String referenceEntity)
    Make a Standard Pay-down Label from the Reference Entity Name

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PaydownLabel

      public PaydownLabel​(java.lang.String referenceEntity) throws java.lang.Exception
      PaydownLabel constructor
      Parameters:
      referenceEntity - The Reference Entity Name
      Throws:
      java.lang.Exception - Thrown if the inputs are invalid

  • Method Details

    • Standard

      public static final PaydownLabel Standard​(java.lang.String referenceEntity)
      Make a Standard Pay-down Label from the Reference Entity Name
      Parameters:
      referenceEntity - The Reference Entity Name
      Returns:
      The Pay-down 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.