Package org.drip.state.identifier

Class EntityEquityLabel

java.lang.Object
org.drip.state.identifier.EntityDesignateLabel
org.drip.state.identifier.EntityEquityLabel
All Implemented Interfaces:
LatentStateLabel
public class EntityEquityLabel
extends EntityDesignateLabel
EntityEquityLabel contains the Identifier Parameters referencing the Latent State of the Entity Equity Curve. It implements the following Functionality.
  • EntityEquityLabel Constructor
  • Retrieve the Ticker
  • Retrieve the Tick Size
  • Make a Standard Equity Entity 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

  • Field Summary

    Fields
    Modifier and Type Field Description
    static double DEFAULT_TICK_SIZE
    Tick Size Default 1 cent

  • Method Summary

    Modifier and Type Method Description
    boolean match​(LatentStateLabel latentStateLabelOther)
    Indicate whether this Label matches the supplied.
    static EntityEquityLabel Standard​(java.lang.String referenceEntity, java.lang.String currency)
    Make a Standard Equity Entity Label from the Reference Entity Name
    java.lang.String ticker()
    Retrieve the Ticker
    double tickSize()
    Retrieve the Tick Size

    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

  • Field Details

    • DEFAULT_TICK_SIZE

      public static final double DEFAULT_TICK_SIZE
      Tick Size Default 1 cent
      See Also:
      Constant Field Values

  • Method Details

    • Standard

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

    • ticker

      public java.lang.String ticker()
      Retrieve the Ticker
      Returns:
      The Ticker

    • tickSize

      public double tickSize()
      Retrieve the Tick Size
      Returns:
      The Tick Size

    • 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.