Package org.drip.state.identifier

Class CustomLabel

java.lang.Object
org.drip.state.identifier.CustomLabel
All Implemented Interfaces:
LatentStateLabel
public class CustomLabel
extends java.lang.Object
implements LatentStateLabel
CustomLabel contains the Identifier Parameters referencing the Latent State of the named Custom Metric. Currently it only contains the Arbitrarily Assigned Label. It implements the following Functionality.
  • CustomLabel constructor
  • Make a Standard Custom Metric Label 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
    CustomLabel​(java.lang.String customMetricLabel)
    CustomLabel 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 CustomLabel Standard​(java.lang.String customMetricLabel)
    Make a Standard Custom Metric Label Instance

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CustomLabel

      public CustomLabel​(java.lang.String customMetricLabel) throws java.lang.Exception
      CustomLabel constructor
      Parameters:
      customMetricLabel - The Custom Metric Label
      Throws:
      java.lang.Exception - Thrown if the inputs are invalid

  • Method Details

    • Standard

      public static final CustomLabel Standard​(java.lang.String customMetricLabel)
      Make a Standard Custom Metric Label Instance
      Parameters:
      customMetricLabel - The Custom Metric Label
      Returns:
      The Custom Label Instance

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