CSVParser.java
package org.drip.feed.loader;
/*
* -*- mode: java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*/
/*!
* Copyright (C) 2020 Lakshmi Krishnamurthy
* 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
*
* 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>CSVParser</i> Parses the Lines of a Comma Separated File into appropriate Data Types.
*
* <br><br>
* <ul>
* <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationalCore.md">Computational Core Module</a></li>
* <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationSupportLibrary.md">Computation Support</a></li>
* <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/feed/README.md">Load, Transform, and compute Target Metrics across Feeds</a></li>
* <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/feed/loader/README.md">Reference/Market Data Feed Loader</a></li>
* </ul>
*
* @author Lakshmi Krishnamurthy
*/
public class CSVParser {
/**
* Parse the Contents of the CSV File into a List of String Arrays
*
* @param strCSVFile The CSV File
* @param bIgnoreHeader TRUE - Ignore the Leading Row as a Header
*
* @return List of String Arrays
*/
@SuppressWarnings ("resource") public static final org.drip.feed.loader.CSVGrid StringGrid (
final java.lang.String strCSVFile,
final boolean bIgnoreHeader)
{
if (null == strCSVFile || strCSVFile.isEmpty()) return null;
boolean bHeader = true;
java.lang.String strCSVLine = "";
java.io.BufferedReader brCSV = null;
org.drip.feed.loader.CSVGrid csvGrid = new org.drip.feed.loader.CSVGrid();
try {
brCSV = new java.io.BufferedReader (new java.io.FileReader (strCSVFile));
while (null != (strCSVLine = brCSV.readLine())) {
java.lang.String[] astrValue = org.drip.numerical.common.StringUtil.Split (strCSVLine, ",");
if (null != astrValue && 0 != astrValue.length) {
if (!bHeader || !bIgnoreHeader) csvGrid.add (astrValue);
bHeader = false;
}
}
return csvGrid;
} catch (java.lang.Exception e) {
e.printStackTrace();
}
return null;
}
/**
* Parse the Contents of the CSV File into a List of Named String Arrays
*
* @param strCSVFile The CSV File
*
* @return List of String Arrays
*/
@SuppressWarnings ("resource") public static final org.drip.feed.loader.CSVGrid NamedStringGrid (
final java.lang.String strCSVFile)
{
if (null == strCSVFile || strCSVFile.isEmpty()) return null;
boolean bHeader = true;
java.lang.String strCSVLine = "";
java.io.BufferedReader brCSV = null;
org.drip.feed.loader.CSVGrid csvGrid = new org.drip.feed.loader.CSVGrid();
try {
brCSV = new java.io.BufferedReader (new java.io.FileReader (strCSVFile));
while (null != (strCSVLine = brCSV.readLine())) {
java.lang.String[] astrValue = org.drip.numerical.common.StringUtil.Split (strCSVLine, ",");
if (null != astrValue && 0 != astrValue.length) {
if (bHeader)
csvGrid.setHeader (astrValue);
else
csvGrid.add (astrValue);
bHeader = false;
}
}
return csvGrid;
} catch (java.lang.Exception e) {
e.printStackTrace();
}
return null;
}
}