FixFloatProcessor.java

  1. package org.drip.service.json;

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

  77. /**
  78.  * <i>FixFloatProcessor</i> Sets Up and Executes a JSON Based In/Out Fix Float Swap Valuation Processor.
  79.  *
  80.  * <br><br>
  81.  *  <ul>
  82.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationalCore.md">Computational Core Module</a></li>
  83.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationSupportLibrary.md">Computation Support</a></li>
  84.  *      <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>
  85.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/service/json/README.md">JSON Based Valuation Request Service</a></li>
  86.  *  </ul>
  87.  * <br><br>
  88.  *
  89.  * @author Lakshmi Krishnamurthy
  90.  */

  91. public class FixFloatProcessor {

  92.     /**
  93.      * JSON Based in/out Funding Fix Float Curve Metrics Thunker
  94.      *
  95.      * @param jsonParameter JSON Funding Fix Float Request Parameters
  96.      *
  97.      * @return JSON Funding Fix Float Curve Metrics Response
  98.      */

  99.     @SuppressWarnings ("unchecked") static final org.drip.json.simple.JSONObject CurveMetrics (
  100.         final org.drip.json.simple.JSONObject jsonParameter)
  101.     {
  102.         org.drip.state.discount.MergedDiscountForwardCurve dcFunding =
  103.             org.drip.service.json.LatentStateProcessor.FundingCurve (jsonParameter);

  104.         if (null == dcFunding) return null;

  105.         org.drip.param.market.CurveSurfaceQuoteContainer csqc = new
  106.             org.drip.param.market.CurveSurfaceQuoteContainer();

  107.         if (!csqc.setFundingState (dcFunding)) return null;

  108.         org.drip.analytics.date.JulianDate dtSpot = dcFunding.epoch();

  109.         org.drip.product.rates.FixFloatComponent irs = null;

  110.         try {
  111.             irs = org.drip.service.template.OTCInstrumentBuilder.FixFloatStandard (dtSpot,
  112.                 dcFunding.currency(), "ALL", org.drip.json.parser.Converter.StringEntry (jsonParameter,
  113.                     "FixFloatMaturity"), "MAIN", org.drip.json.parser.Converter.DoubleEntry (jsonParameter,
  114.                         "FixFloatCoupon"));
  115.         } catch (java.lang.Exception e) {
  116.             e.printStackTrace();

  117.             return null;
  118.         }

  119.         if (null == irs) return null;

  120.         java.util.Map<java.lang.String, java.lang.Double> mapResult = irs.value
  121.             (org.drip.param.valuation.ValuationParams.Spot (dtSpot.julian()), null, csqc, null);

  122.         if (null == mapResult) return null;

  123.         org.drip.json.simple.JSONObject jsonResponse = new org.drip.json.simple.JSONObject();

  124.         for (java.util.Map.Entry<java.lang.String, java.lang.Double> me : mapResult.entrySet())
  125.             jsonResponse.put (me.getKey(), me.getValue());

  126.         org.drip.json.simple.JSONArray jsonFixedCashFlowArray = new org.drip.json.simple.JSONArray();

  127.         for (org.drip.analytics.cashflow.CompositePeriod cp : irs.referenceStream().cashFlowPeriod()) {
  128.             org.drip.json.simple.JSONObject jsonCashFlow = new org.drip.json.simple.JSONObject();

  129.             try {
  130.                 jsonCashFlow.put ("StartDate", new org.drip.analytics.date.JulianDate
  131.                     (cp.startDate()).toString());

  132.                 jsonCashFlow.put ("EndDate", new org.drip.analytics.date.JulianDate
  133.                     (cp.endDate()).toString());

  134.                 jsonCashFlow.put ("PayDate", new org.drip.analytics.date.JulianDate
  135.                     (cp.payDate()).toString());

  136.                 jsonCashFlow.put ("FixingDate", new org.drip.analytics.date.JulianDate
  137.                     (cp.fxFixingDate()).toString());

  138.                 jsonCashFlow.put ("CouponDCF", cp.couponDCF());

  139.                 jsonCashFlow.put ("PayDiscountFactor", cp.df (csqc));
  140.             } catch (java.lang.Exception e) {
  141.                 e.printStackTrace();

  142.                 return null;
  143.             }

  144.             jsonCashFlow.put ("BaseNotional", cp.baseNotional());

  145.             jsonCashFlow.put ("Tenor", cp.tenor());

  146.             jsonCashFlow.put ("FundingLabel", cp.fundingLabel().fullyQualifiedName());

  147.             jsonCashFlow.put ("ReferenceRate", cp.couponMetrics (dtSpot.julian(), csqc).rate());

  148.             jsonFixedCashFlowArray.add (jsonCashFlow);
  149.         }

  150.         jsonResponse.put ("FixedCashFlow", jsonFixedCashFlowArray);

  151.         org.drip.json.simple.JSONArray jsonFloatingCashFlowArray = new org.drip.json.simple.JSONArray();

  152.         for (org.drip.analytics.cashflow.CompositePeriod cp : irs.derivedStream().cashFlowPeriod()) {
  153.             org.drip.json.simple.JSONObject jsonCashFlow = new org.drip.json.simple.JSONObject();

  154.             try {
  155.                 jsonCashFlow.put ("StartDate", new org.drip.analytics.date.JulianDate
  156.                     (cp.startDate()).toString());

  157.                 jsonCashFlow.put ("EndDate", new org.drip.analytics.date.JulianDate
  158.                     (cp.endDate()).toString());

  159.                 jsonCashFlow.put ("PayDate", new org.drip.analytics.date.JulianDate
  160.                     (cp.payDate()).toString());

  161.                 jsonCashFlow.put ("FixingDate", new org.drip.analytics.date.JulianDate
  162.                     (cp.fxFixingDate()).toString());

  163.                 jsonCashFlow.put ("CouponDCF", cp.couponDCF());

  164.                 jsonCashFlow.put ("PayDiscountFactor", cp.df (csqc));
  165.             } catch (java.lang.Exception e) {
  166.                 e.printStackTrace();

  167.                 return null;
  168.             }

  169.             jsonCashFlow.put ("BaseNotional", cp.baseNotional());

  170.             jsonCashFlow.put ("Tenor", cp.tenor());

  171.             jsonCashFlow.put ("FundingLabel", cp.fundingLabel().fullyQualifiedName());

  172.             jsonCashFlow.put ("ForwardLabel", ((org.drip.state.identifier.ForwardLabel)
  173.                 cp.floaterLabel()).fullyQualifiedName());

  174.             jsonCashFlow.put ("ReferenceRate", cp.couponMetrics (dtSpot.julian(), csqc).rate());

  175.             jsonFloatingCashFlowArray.add (jsonCashFlow);
  176.         }

  177.         jsonResponse.put ("FloatingCashFlow", jsonFloatingCashFlowArray);

  178.         return jsonResponse;
  179.     }
  180. }