BlockClassification

java.lang.Object

org.drip.portfolioconstruction.core.Block

org.drip.portfolioconstruction.composite.BlockClassification

public class BlockClassification
extends Block

BlockClassification contains the Classifications for the specified Set of Assets.

Module = Portfolio Core Module
Library = Asset Allocation Analytics
Project = Portfolio Construction under Allocation Constraints
Package = Portfolio Construction Component Groups Suite

Author:: Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor Description

BlockClassification(java.lang.String name, java.lang.String id, java.lang.String description)
Classification Constructor

Method Summary

Modifier and Type	Method	Description
`boolean`	`add(java.lang.String assetID, boolean membership)`	Add an Asset's Membership
`double[]`	`constrict(Holdings holdings)`	Constrict the Classification Values to those of the Holdings
`boolean`	`membership(java.lang.String assetID)`	Retrieve the Asset's Membership
`java.util.Map<java.lang.String,java.lang.Boolean>`	`membershipMap()`	Retrieve the Map of Asset Classification

Methods inherited from class org.drip.portfolioconstruction.core.Block

description, hashCode, id, name, Standard, timeStamp

Methods inherited from class java.lang.Object

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

Constructor Details
- BlockClassification
  
  public BlockClassification(java.lang.String name, java.lang.String id, java.lang.String description) throws java.lang.Exception
  
  Classification Constructor
  
  Parameters:
  
  name - The Name
  
  id - The ID
  
  description - The Description
  
  Throws:
  
  java.lang.Exception - Thrown if the Inputs are Invalid
Method Details
- add
  
  public boolean add(java.lang.String assetID, boolean membership)
  
  Add an Asset's Membership
  
  Parameters:
  
  assetID - The Asset ID
  
  membership - The Membership TURUE or FALSE
  
  Returns:
  
  TRUE - The Asset's Attribute successfully added.
- membership
  
  public boolean membership(java.lang.String assetID) throws java.lang.Exception
  
  Retrieve the Asset's Membership
  
  Parameters:
  
  assetID - The Asset ID
  
  Returns:
  
  The Asset's Membership
  
  Throws:
  
  java.lang.Exception - Thrown if the Inputs are Invalid
- membershipMap
  
  public java.util.Map<java.lang.String,java.lang.Boolean> membershipMap()
  
  Retrieve the Map of Asset Classification
  
  Returns:
  
  Map of the Asset Classification
- constrict
  
  public double[] constrict(Holdings holdings)
  
  Constrict the Classification Values to those of the Holdings
  
  Parameters:
  
  holdings - The Holdings Instance
  
  Returns:
  
  The Array of Classification Values