Class EntityHazardLabel

java.lang.Object
org.drip.state.identifier.EntityDesignateLabel
org.drip.state.identifier.EntityHazardLabel
All Implemented Interfaces:
LatentStateLabel

public class EntityHazardLabel
extends EntityDesignateLabel
EntityHazardLabel contains the Identifier Parameters referencing the Latent State of the Entity Hazard Curve. It implements the following Functionality.
  • EntityHazardLabel Constructor
  • Make a Standard Entity Hazard Label from the Reference Entity Name

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
    EntityHazardLabel​(java.lang.String referenceEntity, java.lang.String currency)
    EntityHazardLabel constructor
  • Method Summary

    Modifier and Type Method Description
    boolean match​(LatentStateLabel latentStateLabelOther)
    Indicate whether this Label matches the supplied.
    static EntityHazardLabel Standard​(java.lang.String referenceEntity, java.lang.String currency)
    Make a Standard Entity Hazard Label from the Reference Entity Name

    Methods inherited from class org.drip.state.identifier.EntityDesignateLabel

    currency, fullyQualifiedName, referenceEntity

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • EntityHazardLabel

      public EntityHazardLabel​(java.lang.String referenceEntity, java.lang.String currency) throws java.lang.Exception
      EntityHazardLabel constructor
      Parameters:
      referenceEntity - The Reference Entity
      currency - The Currency
      Throws:
      java.lang.Exception - Thrown if the inputs are invalid
  • Method Details

    • Standard

      public static final EntityHazardLabel Standard​(java.lang.String referenceEntity, java.lang.String currency)
      Make a Standard Entity Hazard Label from the Reference Entity Name
      Parameters:
      referenceEntity - The Reference Entity Name
      currency - The Currency
      Returns:
      The Hazard Label
    • match

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