Package org.drip.portfolioconstruction.core

Class Universe

java.lang.Object
org.drip.portfolioconstruction.core.Universe
public class Universe
extends java.lang.Object
Universe contains all the Assets in the Universe.



Author:
Lakshmi Krishnamurthy

  • Constructor Summary

    Constructors
    Constructor Description
    Universe()
    Empty Universe Constructor

  • Method Summary

    Modifier and Type Method Description
    boolean addAssetPosition​(AssetPosition assetPosition)
    Add an Asset Position to the Universe
    boolean addHoldings​(Holdings holdings)
    Add a Holdings Entity
    java.util.Set<java.lang.String> assetPositionIDSet()
    Retrieve the List of the Asset Position Identifiers
    java.util.Map<java.lang.String,​AssetPosition> assetPositionMap()
    Retrieve the Asset Position Map
    boolean containsAssetInHoldings​(Asset asset)
    Indicate if the Asset is contained in the Universe Holdings
    boolean containsAssetInPosition​(Asset asset)
    Indicate if the Asset is contained in the Universe
    boolean containsAssetPosition​(java.lang.String id)
    Indicate if the Asset Position is contained in the Universe
    boolean containsAssetPosition​(AssetPosition assetPosition)
    Indicate if the Asset Position is contained in the Universe
    boolean containsHoldings​(java.lang.String id)
    Indicate if the Holdings is contained in the Universe
    boolean containsHoldings​(Holdings holdings)
    Indicate if the Holdings is contained in the Universe
    java.util.Set<java.lang.String> holdingsIDSet()
    Retrieve the List of the Holdings Identifiers
    java.util.Map<java.lang.String,​Holdings> holdingsMap()
    Retrieve the Holdings Map
    Asset retrieveAssetPosition​(java.lang.String id)
    Retrieve the Asset Position corresponding to the ID
    Holdings retrieveHoldings​(java.lang.String id)
    Retrieve the Holdings corresponding to the ID

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Universe

      public Universe()
      Empty Universe Constructor

  • Method Details

    • holdingsMap

      public java.util.Map<java.lang.String,​Holdings> holdingsMap()
      Retrieve the Holdings Map
      Returns:
      Holdings Map

    • assetPositionMap

      public java.util.Map<java.lang.String,​AssetPosition> assetPositionMap()
      Retrieve the Asset Position Map
      Returns:
      Asset Position Map

    • addAssetPosition

      public boolean addAssetPosition​(AssetPosition assetPosition)
      Add an Asset Position to the Universe
      Parameters:
      assetPosition - Asset Position to be added
      Returns:
      TRUE - The Asset Position has been added successfully

    • addHoldings

      public boolean addHoldings​(Holdings holdings)
      Add a Holdings Entity
      Parameters:
      holdings - Holdings Entity
      Returns:
      TRUE - The Holdings Entity successfully added

    • containsAssetInPosition

      public boolean containsAssetInPosition​(Asset asset)
      Indicate if the Asset is contained in the Universe
      Parameters:
      asset - The Asset Position Instance
      Returns:
      TRUE - The Asset is contained in the Universe

    • containsAssetPosition

      public boolean containsAssetPosition​(AssetPosition assetPosition)
      Indicate if the Asset Position is contained in the Universe
      Parameters:
      assetPosition - The Asset Position Instance
      Returns:
      TRUE - The Asset Position is contained in the Universe

    • containsHoldings

      public boolean containsHoldings​(Holdings holdings)
      Indicate if the Holdings is contained in the Universe
      Parameters:
      holdings - Holdings
      Returns:
      TRUE - The Holdings is contained in the Universe

    • containsAssetInHoldings

      public boolean containsAssetInHoldings​(Asset asset)
      Indicate if the Asset is contained in the Universe Holdings
      Parameters:
      asset - The Asset Position Instance
      Returns:
      TRUE - The Asset is contained in the Universe Holdings

    • containsAssetPosition

      public boolean containsAssetPosition​(java.lang.String id)
      Indicate if the Asset Position is contained in the Universe
      Parameters:
      id - The Asset Position ID
      Returns:
      TRUE - The Asset Position is contained in the Universe

    • containsHoldings

      public boolean containsHoldings​(java.lang.String id)
      Indicate if the Holdings is contained in the Universe
      Parameters:
      id - Holdings ID
      Returns:
      TRUE - The Holdings is contained in the Universe

    • assetPositionIDSet

      public java.util.Set<java.lang.String> assetPositionIDSet()
      Retrieve the List of the Asset Position Identifiers
      Returns:
      The List of the Asset Position Identifiers

    • holdingsIDSet

      public java.util.Set<java.lang.String> holdingsIDSet()
      Retrieve the List of the Holdings Identifiers
      Returns:
      The List of the Holdings Identifiers

    • retrieveAssetPosition

      public Asset retrieveAssetPosition​(java.lang.String id)
      Retrieve the Asset Position corresponding to the ID
      Parameters:
      id - ID
      Returns:
      Asset Position corresponding to the ID

    • retrieveHoldings

      public Holdings retrieveHoldings​(java.lang.String id)
      Retrieve the Holdings corresponding to the ID
      Parameters:
      id - ID
      Returns:
      Holdings corresponding to the ID