org.drip.state.representation

Class LatentStateSpecification

java.lang.Object

org.drip.state.representation.LatentStateSpecification

public class LatentStateSpecification
extends java.lang.Object

LatentStateSpecification holds the fields necessary to specify a complete Latent State. It includes the Latent State Type, the Latent State Label, and the Latent State Quantification metric.

Author:

Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor and Description
LatentStateSpecification(java.lang.String strLatentState, java.lang.String strLatentStateQuantificationMetric, LatentStateLabel label) LatentStateSpecification constructor

Method Summary

Modifier and Type	Method and Description
void	displayString(java.lang.String strComment) Display the Latent State Details
LatentStateLabel	label() Retrieve the Latent State Label
java.lang.String	latentState() Retrieve the Latent State
java.lang.String	latentStateQuantificationMetric() Retrieve the Latent State Quantification Metric
boolean	match(LatentStateSpecification lssOther) Does the Specified Latent State Specification Instance match the current one?

Methods inherited from class java.lang.Object

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

Constructor Detail

LatentStateSpecification

public LatentStateSpecification(java.lang.String strLatentState,
                                java.lang.String strLatentStateQuantificationMetric,
                                LatentStateLabel label)
                         throws java.lang.Exception

LatentStateSpecification constructor

Parameters:

strLatentState - The Latent State

strLatentStateQuantificationMetric - The Latent State Quantification Metric

label - The Specific Latent State Label

Throws:

java.lang.Exception - Thrown if the Inputs are invalid

Method Detail

latentState

public java.lang.String latentState()

Retrieve the Latent State

Returns:

The Latent State

label

public LatentStateLabel label()

Retrieve the Latent State Label

Returns:

The Latent State Label

latentStateQuantificationMetric

public java.lang.String latentStateQuantificationMetric()

Retrieve the Latent State Quantification Metric

Returns:

The Latent State Quantification Metric

match

public boolean match(LatentStateSpecification lssOther)

Does the Specified Latent State Specification Instance match the current one?

Parameters:

lssOther - The "Other" Latent State Specification Instance

Returns:

TRUE - Matches the Specified Latent State Specification Instance

displayString

public void displayString(java.lang.String strComment)

Display the Latent State Details

Parameters:

strComment - The Comment Prefix