InvocationManager.java

  1. package org.drip.service.env;

  2. /*
  3.  * -*- mode: java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  4.  */

  5. /*!
  6.  * Copyright (C) 2020 Lakshmi Krishnamurthy
  7.  * Copyright (C) 2019 Lakshmi Krishnamurthy
  8.  * Copyright (C) 2018 Lakshmi Krishnamurthy
  9.  * Copyright (C) 2017 Lakshmi Krishnamurthy
  10.  *
  11.  *  This file is part of DROP, an open-source library targeting analytics/risk, transaction cost analytics,
  12.  *      asset liability management analytics, capital, exposure, and margin analytics, valuation adjustment
  13.  *      analytics, and portfolio construction analytics within and across fixed income, credit, commodity,
  14.  *      equity, FX, and structured products. It also includes auxiliary libraries for algorithm support,
  15.  *      numerical analysis, numerical optimization, spline builder, model validation, statistical learning,
  16.  *      and computational support.
  17.  *  
  18.  *      https://lakshmidrip.github.io/DROP/
  19.  *  
  20.  *  DROP is composed of three modules:
  21.  *  
  22.  *  - DROP Product Core - https://lakshmidrip.github.io/DROP-Product-Core/
  23.  *  - DROP Portfolio Core - https://lakshmidrip.github.io/DROP-Portfolio-Core/
  24.  *  - DROP Computational Core - https://lakshmidrip.github.io/DROP-Computational-Core/
  25.  *
  26.  *  DROP Product Core implements libraries for the following:
  27.  *  - Fixed Income Analytics
  28.  *  - Loan Analytics
  29.  *  - Transaction Cost Analytics
  30.  *
  31.  *  DROP Portfolio Core implements libraries for the following:
  32.  *  - Asset Allocation Analytics
  33.  *  - Asset Liability Management Analytics
  34.  *  - Capital Estimation Analytics
  35.  *  - Exposure Analytics
  36.  *  - Margin Analytics
  37.  *  - XVA Analytics
  38.  *
  39.  *  DROP Computational Core implements libraries for the following:
  40.  *  - Algorithm Support
  41.  *  - Computation Support
  42.  *  - Function Analysis
  43.  *  - Model Validation
  44.  *  - Numerical Analysis
  45.  *  - Numerical Optimizer
  46.  *  - Spline Builder
  47.  *  - Statistical Learning
  48.  *
  49.  *  Documentation for DROP is Spread Over:
  50.  *
  51.  *  - Main                     => https://lakshmidrip.github.io/DROP/
  52.  *  - Wiki                     => https://github.com/lakshmiDRIP/DROP/wiki
  53.  *  - GitHub                   => https://github.com/lakshmiDRIP/DROP
  54.  *  - Repo Layout Taxonomy     => https://github.com/lakshmiDRIP/DROP/blob/master/Taxonomy.md
  55.  *  - Javadoc                  => https://lakshmidrip.github.io/DROP/Javadoc/index.html
  56.  *  - Technical Specifications => https://github.com/lakshmiDRIP/DROP/tree/master/Docs/Internal
  57.  *  - Release Versions         => https://lakshmidrip.github.io/DROP/version.html
  58.  *  - Community Credits        => https://lakshmidrip.github.io/DROP/credits.html
  59.  *  - Issues Catalog           => https://github.com/lakshmiDRIP/DROP/issues
  60.  *  - JUnit                    => https://lakshmidrip.github.io/DROP/junit/index.html
  61.  *  - Jacoco                   => https://lakshmidrip.github.io/DROP/jacoco/index.html
  62.  *
  63.  *  Licensed under the Apache License, Version 2.0 (the "License");
  64.  *      you may not use this file except in compliance with the License.
  65.  *  
  66.  *  You may obtain a copy of the License at
  67.  *      http://www.apache.org/licenses/LICENSE-2.0
  68.  *  
  69.  *  Unless required by applicable law or agreed to in writing, software
  70.  *      distributed under the License is distributed on an "AS IS" BASIS,
  71.  *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  72.  *  
  73.  *  See the License for the specific language governing permissions and
  74.  *      limitations under the License.
  75.  */

  76. /**
  77.  * <i>InvocationManager</i> records the manages the Build/Execution Environment of an Invocation.
  78.  *
  79.  * <br><br>
  80.  *  <ul>
  81.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationalCore.md">Computational Core Module</a></li>
  82.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationSupportLibrary.md">Computation Support</a></li>
  83.  *      <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/service/README.md">Environment, Product/Definition Containers, and Scenario/State Manipulation APIs</a></li>
  84.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/service/env/README.md">Library Module Loader Environment Manager</a></li>
  85.  *  </ul>
  86.  * <br><br>
  87.  *
  88.  * @author Lakshmi Krishnamurthy
  89.  */

  90. public class InvocationManager
  91. {
  92.     private static org.drip.service.env.BuildRecord s_BuildRecordLatest = null;
  93.     private static org.drip.service.env.InvocationRecord s_InvocationRecord = null;

  94.     /**
  95.      * Initialize the Invocation Manager
  96.      *
  97.      * @return TRUE - The Invocation Manager successfully initialized
  98.      */

  99.     public static final boolean Init()
  100.     {
  101.         if (!org.drip.service.env.BuildManager.Init())
  102.         {
  103.             System.out.println ("InvocationManager::Init => Cannot Initialize Build Manager!");

  104.             return false;
  105.         }

  106.         s_BuildRecordLatest = org.drip.service.env.BuildManager.latestBuildRecord();

  107.         s_InvocationRecord = new org.drip.service.env.InvocationRecord();

  108.         return true;
  109.     }

  110.     /**
  111.      * Setup the Invocation Manager
  112.      *
  113.      * @return TRUE - The Invocation Manager successfully Setup
  114.      */

  115.     public static final boolean Setup()
  116.     {
  117.         if (!s_InvocationRecord.recordSetup()) return false;

  118.         System.out.println();

  119.         System.out.println ("\t|-----------------------------------------------------------------|");

  120.         System.out.println ("\t|    Copyright (C) 2011-2020 (DRIP, DROP)");

  121.         System.out.println ("\t|-----------------------------------------------------------------|");

  122.         System.out.println ("\t|    Build Version  => " + s_BuildRecordLatest.dripVersion() + " multi mode");

  123.         System.out.println ("\t|    Build JVM (TM) => " + s_BuildRecordLatest.javaVersion());

  124.         System.out.println ("\t|    Build Snap     => " + s_BuildRecordLatest.timeStamp());

  125.         System.out.println ("\t|    Start Time     => " + s_InvocationRecord.startSnap());

  126.         System.out.println ("\t|    Setup Time     => " + s_InvocationRecord.setupSnap());

  127.         System.out.println ("\t|    Setup Duration => " + s_InvocationRecord.setup (true));

  128.         System.out.println ("\t|-----------------------------------------------------------------|");

  129.         System.out.println();

  130.         return true;
  131.     }

  132.     /**
  133.      * Retrieve the Latest Build Record
  134.      *
  135.      * @return The Latest Build Record
  136.      */

  137.     public static final org.drip.service.env.BuildRecord latestBuildRecord()
  138.     {
  139.         return s_BuildRecordLatest;
  140.     }

  141.     /**
  142.      * Retrieve the Invocation Record
  143.      *
  144.      * @return The Invocation Record
  145.      */

  146.     public static final org.drip.service.env.InvocationRecord invocationRecord()
  147.     {
  148.         return s_InvocationRecord;
  149.     }

  150.     /**
  151.      * Terminate the Invocation Manager
  152.      *
  153.      * @return TRUE - The Invocation Manager successfully terminated
  154.      */

  155.     public static final boolean Terminate()
  156.     {
  157.         if (!s_InvocationRecord.recordFinish()) return false;

  158.         System.out.println();

  159.         System.out.println ("\t|-----------------------------------------------------------------|");

  160.         System.out.println ("\t|    Copyright (C) 2011-2020 (DRIP, DROP)");

  161.         System.out.println ("\t|-----------------------------------------------------------------|");

  162.         System.out.println ("\t|    Build Version  => " + s_BuildRecordLatest.dripVersion() + " multi mode");

  163.         System.out.println ("\t|    Build JVM (TM) => " + s_BuildRecordLatest.javaVersion());

  164.         System.out.println ("\t|    Build Snap     => " + s_BuildRecordLatest.timeStamp());

  165.         System.out.println ("\t|    Start Time     => " + s_InvocationRecord.startSnap());

  166.         System.out.println ("\t|    Setup Time     => " + s_InvocationRecord.setupSnap());

  167.         System.out.println ("\t|    Finish Time    => " + s_InvocationRecord.finishSnap());

  168.         System.out.println ("\t|    Setup Duration => " + s_InvocationRecord.setup (true));

  169.         System.out.println ("\t|    Run Duration   => " + s_InvocationRecord.elapsed (true));

  170.         System.out.println ("\t|-----------------------------------------------------------------|");

  171.         System.out.println();

  172.         return true;
  173.     }
  174. }