JurisdictionIBORIndexDefinition.java

package org.drip.sample.forward;

import org.drip.analytics.support.CompositePeriodBuilder;
import org.drip.market.definition.*;
import org.drip.service.env.EnvManager;

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

/*!
 * Copyright (C) 2019 Lakshmi Krishnamurthy
 * Copyright (C) 2018 Lakshmi Krishnamurthy
 * Copyright (C) 2017 Lakshmi Krishnamurthy
 * Copyright (C) 2016 Lakshmi Krishnamurthy
 * Copyright (C) 2015 Lakshmi Krishnamurthy
 * Copyright (C) 2014 Lakshmi Krishnamurthy
 * 
 *  This file is part of DROP, an open-source library targeting risk, transaction costs, exposure, margin
 *      calculations, valuation adjustment, and portfolio construction within and across fixed income,
 *      credit, commodity, equity, FX, and structured products.
 *  
 *      https://lakshmidrip.github.io/DROP/
 *  
 *  DROP is composed of three modules:
 *  
 *  - DROP Analytics Core - https://lakshmidrip.github.io/DROP-Analytics-Core/
 *  - DROP Portfolio Core - https://lakshmidrip.github.io/DROP-Portfolio-Core/
 *  - DROP Numerical Core - https://lakshmidrip.github.io/DROP-Numerical-Core/
 * 
 *  DROP Analytics Core implements libraries for the following:
 *  - Fixed Income Analytics
 *  - Asset Backed Analytics
 *  - XVA Analytics
 *  - Exposure and Margin Analytics
 * 
 *  DROP Portfolio Core implements libraries for the following:
 *  - Asset Allocation Analytics
 *  - Transaction Cost Analytics
 * 
 *  DROP Numerical Core implements libraries for the following:
 *  - Statistical Learning
 *  - Numerical Optimizer
 *  - Spline Builder
 *  - Algorithm Support
 * 
 *  Documentation for DROP is Spread Over:
 * 
 *  - Main                     => https://lakshmidrip.github.io/DROP/
 *  - Wiki                     => https://github.com/lakshmiDRIP/DROP/wiki
 *  - GitHub                   => https://github.com/lakshmiDRIP/DROP
 *  - Repo Layout Taxonomy     => https://github.com/lakshmiDRIP/DROP/blob/master/Taxonomy.md
 *  - Javadoc                  => https://lakshmidrip.github.io/DROP/Javadoc/index.html
 *  - Technical Specifications => https://github.com/lakshmiDRIP/DROP/tree/master/Docs/Internal
 *  - Release Versions         => https://lakshmidrip.github.io/DROP/version.html
 *  - Community Credits        => https://lakshmidrip.github.io/DROP/credits.html
 *  - Issues Catalog           => https://github.com/lakshmiDRIP/DROP/issues
 *  - JUnit                    => https://lakshmidrip.github.io/DROP/junit/index.html
 *  - Jacoco                   => https://lakshmidrip.github.io/DROP/jacoco/index.html
 * 
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *      you may not use this file except in compliance with the License.
 *   
 *  You may obtain a copy of the License at
 *      http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing, software
 *      distributed under the License is distributed on an "AS IS" BASIS,
 *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  
 *  See the License for the specific language governing permissions and
 *      limitations under the License.
 */

/**
 * <i>JurisdictionIBORIndexDefinition</i> demonstrates the functionality to retrieve the IBOR settings for
 * the various Jurisdictions.
 *  
 * <br><br>
 *  <ul>
 *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/AnalyticsCore.md">Analytics Core Module</a></li>
 *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/FixedIncomeAnalyticsLibrary.md">Fixed Income Analytics Library</a></li>
 *      <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/sample/README.md">Sample</a></li>
 *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/sample/forward/README.md">Forward Rate Curve Construction</a></li>
 *  </ul>
 * <br><br>
 * 
 * @author Lakshmi Krishnamurthy
 */

public class JurisdictionIBORIndexDefinition {
    private static final String AccrualType (
        final int iAccrualCompounding)
    {
        return CompositePeriodBuilder.ACCRUAL_COMPOUNDING_RULE_ARITHMETIC == iAccrualCompounding ? "ARITHMETIC" : " GEOMETRIC";
    }

    private static final void DisplayNameOvernightSetting (
        final String strName)
    {
        IBORIndex index = IBORIndexContainer.IndexFromName (strName);

        String strLongestMaturity = index.longestMaturity();

        String strShortestMaturity = index.shortestMaturity();

        System.out.println ("\t[" +
            index.currency() + "] => " +
            index.dayCount() + " | " +
            index.spotLag() + " | " +
            AccrualType (index.accrualCompoundingRule()) + " | " +
            (strShortestMaturity.isEmpty() ? "  " : strShortestMaturity) + " | " +
            (strLongestMaturity.isEmpty() ? "   " : strLongestMaturity) + " | " +
            index.name()
        );
    }

    public static final void main (
        String[] args)
    {
        EnvManager.InitEnv ("");

        System.out.println ("\n\t---------------\n\t---------------\n");

        DisplayNameOvernightSetting ("CHF-LIBOR");

        DisplayNameOvernightSetting ("EUR-EURIBOR");

        DisplayNameOvernightSetting ("EUR-LIBOR");

        DisplayNameOvernightSetting ("GBP-LIBOR");

        DisplayNameOvernightSetting ("JPY-LIBOR");

        DisplayNameOvernightSetting ("USD-LIBOR");

        System.out.println ("\n\t---------------\n\t---------------\n");

        DisplayNameOvernightSetting ("AUD-LIBOR");

        DisplayNameOvernightSetting ("CAD-LIBOR");

        DisplayNameOvernightSetting ("CZK-LIBOR");

        DisplayNameOvernightSetting ("DKK-LIBOR");

        DisplayNameOvernightSetting ("HKD-LIBOR");

        DisplayNameOvernightSetting ("HUF-LIBOR");

        DisplayNameOvernightSetting ("IDR-LIBOR");

        DisplayNameOvernightSetting ("INR-LIBOR");

        DisplayNameOvernightSetting ("NOK-LIBOR");

        DisplayNameOvernightSetting ("NZD-LIBOR");

        DisplayNameOvernightSetting ("PLN-LIBOR");

        DisplayNameOvernightSetting ("RMB-LIBOR");

        DisplayNameOvernightSetting ("SGD-LIBOR");

        DisplayNameOvernightSetting ("SEK-LIBOR");

        DisplayNameOvernightSetting ("SKK-LIBOR");

        DisplayNameOvernightSetting ("ZAR-LIBOR");

        EnvManager.TerminateEnv();
    }
}