PredictorScenarioSpecification.java

package org.drip.capital.systemicscenario;

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

/*!
 * Copyright (C) 2020 Lakshmi Krishnamurthy
 * Copyright (C) 2019 Lakshmi Krishnamurthy
 * 
 *  This file is part of DROP, an open-source library targeting analytics/risk, transaction cost analytics,
 *  	asset liability management analytics, capital, exposure, and margin analytics, valuation adjustment
 *  	analytics, and portfolio construction analytics within and across fixed income, credit, commodity,
 *  	equity, FX, and structured products. It also includes auxiliary libraries for algorithm support,
 *  	numerical analysis, numerical optimization, spline builder, model validation, statistical learning,
 *  	and computational support.
 *  
 *  	https://lakshmidrip.github.io/DROP/
 *  
 *  DROP is composed of three modules:
 *  
 *  - DROP Product Core - https://lakshmidrip.github.io/DROP-Product-Core/
 *  - DROP Portfolio Core - https://lakshmidrip.github.io/DROP-Portfolio-Core/
 *  - DROP Computational Core - https://lakshmidrip.github.io/DROP-Computational-Core/
 * 
 * 	DROP Product Core implements libraries for the following:
 * 	- Fixed Income Analytics
 * 	- Loan Analytics
 * 	- Transaction Cost Analytics
 * 
 * 	DROP Portfolio Core implements libraries for the following:
 * 	- Asset Allocation Analytics
 *  - Asset Liability Management Analytics
 * 	- Capital Estimation Analytics
 * 	- Exposure Analytics
 * 	- Margin Analytics
 * 	- XVA Analytics
 * 
 * 	DROP Computational Core implements libraries for the following:
 * 	- Algorithm Support
 * 	- Computation Support
 * 	- Function Analysis
 *  - Model Validation
 * 	- Numerical Analysis
 * 	- Numerical Optimizer
 * 	- Spline Builder
 *  - Statistical Learning
 * 
 * 	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>PredictorScenarioSpecification</i> specifies the Full Stress Scenario Specification for the given
 * 	Predictor across Market Segments. The References are:
 * 
 * <br><br>
 * 	<ul>
 * 		<li>
 * 			Bank for International Supervision(2005): Stress Testing at Major Financial Institutions: Survey
 * 				Results and Practice https://www.bis.org/publ/cgfs24.htm
 * 		</li>
 * 		<li>
 * 			Glasserman, P. (2004): <i>Monte Carlo Methods in Financial Engineering</i> <b>Springer</b>
 * 		</li>
 * 		<li>
 * 			Kupiec, P. H. (2000): Stress Tests and Risk Capital <i>Risk</i> <b>2 (4)</b> 27-39
 * 		</li>
 * 	</ul>
 *
 *	<br><br>
 *  <ul>
 *		<li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/PortfolioCore.md">Portfolio Core Module</a></li>
 *		<li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/CapitalAnalyticsLibrary.md">Capital Analytics</a></li>
 *		<li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/capital/README.md">Basel Market Risk and Operational Capital</a></li>
 *		<li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/capital/systemicscenario/README.md">Systemic Stress Scenario Design/Construction</a></li>
 *  </ul>
 * 
 * @author Lakshmi Krishnamurthy
 */

public class PredictorScenarioSpecification
{
	private java.lang.String _name = "";
	private java.lang.String _category = "";
	private java.util.Map<java.lang.String, org.drip.capital.systemicscenario.StressScenarioSpecification>
		_segmentScenarioSpecificationMap = null;

	/**
	 * PredictorScenarioSpecification Constructor
	 * 
	 * @param name Predictor Name
	 * @param category Predictor Category
	 * 
	 * @throws java.lang.Exception Thrown if the Inputs are Invalid
	 */

	public PredictorScenarioSpecification (
		final java.lang.String name,
		final java.lang.String category)
		throws java.lang.Exception
	{
		if (null == (_name = name) || _name.isEmpty() ||
			null == (_category = category) || _category.isEmpty())
		{
			throw new java.lang.Exception (
				"PredictorScenarioSpecification Constructor => Invalid Inputs"
			);
		}
	}

	/**
	 * Retrieve the Predictor Name
	 * 
	 * @return The Predictor Name
	 */

	public java.lang.String name()
	{
		return _name;
	}

	/**
	 * Retrieve the Predictor Category
	 * 
	 * @return The Predictor Category
	 */

	public java.lang.String category()
	{
		return _category;
	}

	/**
	 * Retrieve the Market Segment Stress Scenario Specification Map
	 * 
	 * @return The Market Segment Stress Scenario Specification Map
	 */

	public java.util.Map<java.lang.String, org.drip.capital.systemicscenario.StressScenarioSpecification>
		segmentScenarioSpecificationMap()
	{
		return _segmentScenarioSpecificationMap;
	}

	/**
	 * Add the Stress Scenario Specification
	 * 
	 * @param marketSegment The Market Segment
	 * @param segmentScenarioSpecification The Stress Scenario Specification
	 * 
	 * @return TRUE - The Stress Scenario Specification successfully added
	 */

	public boolean addStressScenarioSpecification (
		final java.lang.String marketSegment,
		final org.drip.capital.systemicscenario.StressScenarioSpecification segmentScenarioSpecification)
	{
		if (null == marketSegment || marketSegment.isEmpty() ||
			null == segmentScenarioSpecification)
		{
			return false;
		}

		if (null == _segmentScenarioSpecificationMap)
		{
			_segmentScenarioSpecificationMap = new
				org.drip.analytics.support.CaseInsensitiveHashMap<org.drip.capital.systemicscenario.StressScenarioSpecification>();
		}

		_segmentScenarioSpecificationMap.put (
			marketSegment,
			segmentScenarioSpecification
		);

		return true;
	}

	/**
	 * Indicate the Presence of the Market Segment
	 * 
	 * @param marketSegment Market Segment
	 * 
	 * @return TRUE - The Market Segment is Present
	 */

	public boolean containsStressScenarioSpecification (
		final java.lang.String marketSegment)
	{
		return null != marketSegment && !marketSegment.isEmpty() &&
			_segmentScenarioSpecificationMap.containsKey (
				marketSegment
			);
	}

	/**
	 * Retrieve the Stress Scenario Specification given the Market Segment
	 * 
	 * @param marketSegment Market Segment
	 * 
	 * @return The Stress Scenario Specification
	 */

	public org.drip.capital.systemicscenario.StressScenarioSpecification stressScenarioSpecification (
		final java.lang.String marketSegment)
	{
		return containsStressScenarioSpecification (
			marketSegment
		) ? _segmentScenarioSpecificationMap.get (
			marketSegment
		) : null;
	}
}