SwaptionPortfolio Example Java





http://www.QuantTools.com
CapeTools Swaption Portfolio function list
SwaptionPortfolio function

Welcome | Documentation format | QuantTools Groups | QuantTools Categories | Licence

Key TAGs | Excel Index | API Index



Example Java Driver function. Preparing the parameters and the final function call (the result).

High level view of the code structure (resulting in the final function call to SwaptionPortfolio() )

These are the financial QuantTools function calls that are used within the examples :





The objects generated by these functions are inter-connected in the following way :




Java Example - SwaptionPortfolio





    //     ##################################################################################
    //     The first function here SwaptionPortfolio(), contains a series of
    //     function calls leading upto the main function call, the second function
    //     within this file ( SwaptionPortfolioPart() ).
    //     which contains the answer that we are looking for.

    //     The first function here is simply an example of how to construct the parameters 
    //     in order acquire either a string Key (that is to be passed to other functions) 
    //     or a computed result.

    //     If you are viewing this source code from the chm or web help file you can use the
    //     outlining features to collapse certain sections of the code for better readability. 
    //     ##################################################################################
        

public class Java_EX_SwaptionPortfolio()
{
    static 
    {
        try 
        {
            System.loadLibrary("CTQuantToolsAPI20");
        } 
        catch (UnsatisfiedLinkError e) 
        {
            System.err.println("Native code library failed to load. Make sure that the CTQuantToolsAPI20.dll is installed correctly.\n" + e);
            System.exit(1);
        }
    }

    static int nCTOSPortfolioGlobal = 0;
    
    // Used by function parameters that take an optional range value. 
    // In Excel we simply omit the value, within the API functions, 
    // we pass an empty range object
    static CTQL.CTRangeData oEmptyRange = new CTQL.CTRangeData();
    static String szTickedKeyName;
                

    public static String Java_EX_SwaptionPortfolio(String argv[])
    {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
    nCTOSPortfolioGlobal += 1;
            
    String szErrorMsg = "";

    try
    {



    //    UK date calendar used within the UK stock exchange.
    

    String MyCALUKExchange;
    MyCALUKExchange = 
        CALUKExchangePart();
    
    


    //    EURO calendar used for holiday adjustments.
    

    String MyEuroCal;
    MyEuroCal = 
        CALEUROPart();
    
    


    //    Creates a centralized valuation date object.
    

    String MyValuationDate;
    MyValuationDate = 
        ValueDateObjPart();
    
    


    //    UK date calendar.
    

    String MyCALUKSettlement;
    MyCALUKSettlement = 
        CALUKSettlementPart();
    
    


    //    TARGET calendar used for holiday adjustments.
    

    String MyTargetCal2;
    MyTargetCal2 = 
        CALTARGET__2Part();
    
    


    //    Creates a Deposit template which is almost identical to a Libor 
    //    Index, but without the YieldCurve information.
    
    String MyGBPDepoTPL;
    MyGBPDepoTPL = 
        CreateDepoTemplate__3Part(
        MyCALUKExchange,
        MyCALUKSettlement);
    
    


    //    Creates a Swap template which is almost identical to the definition 
    //    of the parameters of a swap contract, but without the swap duration, 
    //    buysell, and YieldCurve information.
    
    String MyGBPSwapTPL;
    MyGBPSwapTPL = 
        CreateSwapTemplate__4Part(
        MyCALUKSettlement,
        MyGBPDepoTPL);
    
    


    //    Creates a Deposit template which is almost identical to a Libor 
    //    Index, but without the YieldCurve information.
    
    String MyDepoTPL;
    MyDepoTPL = 
        CreateDepoTemplatePart(
        MyCALUKExchange,
        MyEuroCal);
    
    


    //    Creates a Swap template which is almost identical to the definition 
    //    of the parameters of a swap contract, but without the swap duration, 
    //    buysell, and YieldCurve information.
    
    String MySwapTPL;
    MySwapTPL = 
        CreateSwapTemplatePart(
        MyEuroCal,
        MyDepoTPL);
    
    


    //    Creates a yield curve using market rates and cross currency 
    //    swaps (against the dollar).
    
    String MyYC_XCCY_DCF;
    MyYC_XCCY_DCF = 
        MKTYC_XCCY_DPart(
        MyValuationDate,
        MyDepoTPL,
        MySwapTPL);
    
    


    //    Creates a SABR curve to model the dynamics of the volatility 
    //    curve (smile).
    
    String MySABRVolCurve;
    MySABRVolCurve = 
        SABRVolCurvePart(
        MyValuationDate,
        MyDepoTPL,
        MySwapTPL);
    
    


    //    Creates a new Index code.
    
    String My1MIndex;
    My1MIndex = 
        CreateIndex__5Part(
        MyCALUKExchange,
        MyEuroCal,
        MyYC_XCCY_DCF);
    
    


    //    Creates a new Index code.
    
    String My2MIndex;
    My2MIndex = 
        CreateIndex__6Part(
        MyCALUKExchange,
        MyEuroCal,
        MyYC_XCCY_DCF);
    
    


    //    Creates a new Index code.
    
    String My3MIndex;
    My3MIndex = 
        CreateIndex__7Part(
        MyCALUKExchange,
        MyEuroCal,
        MyYC_XCCY_DCF);
    
    


    //    Creates a new Index code.
    
    String My6MIndex;
    My6MIndex = 
        CreateIndex__8Part(
        MyCALUKExchange,
        MyEuroCal,
        MyYC_XCCY_DCF);
    
    


    //    Creates a new Index code.
    
    String My12MIndex;
    My12MIndex = 
        CreateIndex__9Part(
        MyCALUKExchange,
        MyEuroCal,
        MyYC_XCCY_DCF);
    
    


    //    Creates a new Index based on SWAP details.
    
    String MyCMS5Y;
    MyCMS5Y = 
        CreateSwapIndex__2Part(
        MyTargetCal2,
        My3MIndex);
    
    


    //    Creates a new Index based on SWAP details.
    
    String MyCMS10Y;
    MyCMS10Y = 
        CreateSwapIndex__3Part(
        MyTargetCal2,
        My3MIndex);
    
    


    //    Creates a yield curve using market rates (No cross-currency 
    //    Swaps).
    
    String MyGBPYC;
    MyGBPYC = 
        MKTYC_D__4Part(
        MyValuationDate,
        MyGBPDepoTPL,
        MyGBPSwapTPL);
    
    


    //    GBPLibor, Pound Sterling LIBOR fixed by BBA.
    
    String MyGBPIndex;
    MyGBPIndex = 
        IDXGBPLiborPart(
        MyGBPYC);
    
    


    //    Creates a container to hold a group of Index objects.
    
    String MyGroupedIndex;
    MyGroupedIndex = 
        GroupedIndexPart(
        My1MIndex,
        My2MIndex,
        My3MIndex,
        My6MIndex,
        My12MIndex,
        MyGBPIndex,
        MyCMS5Y,
        MyCMS10Y);
    
    


    //    Creates a Swaption portfolio object.
    
    String MySwaptionPortfolio;
    MySwaptionPortfolio = 
        SwaptionPortfolioPart(
        MyGroupedIndex,
        MyYC_XCCY_DCF,
        MySABRVolCurve);
    
    // This is the result we are looking for.
    return MySwaptionPortfolio;
    
    
    }
    catch(Exception e)
    {
        szErrorMsg = e.getMessage();
        System.exit(1);
    }
                    
}                
        


// ///////////////////////////////////////////////////////////////////

private static String SwaptionPortfolioPart(
    String MyGroupedIndex,
    String MyYC_XCCY_DCF,
    String MySABRVolCurve)
{

        //  Create example range for parameter SwaptionPortfolio_SwaptionRange
        CTQL.CTRangeData SwaptionPortfolio_SwaptionRange = 
            new CTQL.CTRangeData();
    
        StringBuffer SwaptionPortfolio_SwaptionRange_builder = new StringBuffer(100);
                         
        // We could set the value for each cell individually, but for display
        // purposes, this is quicker and more informative.
        SwaptionPortfolio_SwaptionRange_builder.append("{");
        SwaptionPortfolio_SwaptionRange_builder.append("SwaptionName     | Position     | PayRec     | ExerciseDate     | StartDate     | EndDate     | Notional     | Coupon     | FixBDC     | FixDayCount     | FixFreq     | IndexCode     | Margin ;");
        SwaptionPortfolio_SwaptionRange_builder.append("OS-123456     | short     | reciever     | #19/Jul/2011#     | #21/Jul/2011#     | #21/Jul/2016#     | 50000000     | 5.17     | Modifiedfollowing     | ACT365F     | S     | EURLIBOR3M     | 0.0002 ;");
        SwaptionPortfolio_SwaptionRange_builder.append("OS : 19-Jul-2012 / 5.31%     | short     | reciever     | #19/Jul/2012#     | #21/Jul/2012#     | #21/Jul/2017#     | 50000000     | 5.31     | Modifiedfollowing     | ACT365F     | S     | EURLIBOR1M     | 0.0002 ;");
        SwaptionPortfolio_SwaptionRange_builder.append("OS : 19-Jul-2013 / 5.47%     | short     | reciever     | #19/Jul/2013#     | #21/Jul/2013#     | #21/Jul/2018#     | 50000000     | 5.47     | Modifiedfollowing     | ACT365F     | S     | EURLIBOR1M     | 0.0002 ;");
        SwaptionPortfolio_SwaptionRange_builder.append("OS : 19-Jul-2014 / 5.59%     | short     | reciever     | #19/Jul/2014#     | #21/Jul/2014#     | #21/Jul/2019#     | 50000000     | 5.59     | Modifiedfollowing     | ACT365F     | S     | EURLIBOR6M     | 0.0002 ;");
        SwaptionPortfolio_SwaptionRange_builder.append("OS : 19-Jul-2015 / 5.74%     | short     | reciever     | #19/Jul/2015#     | #21/Jul/2015#     | #21/Jul/2020#     | 50000000     | 5.74     | Modifiedfollowing     | ACT365F     | S     | EURLIBOR6M     | 0.0002 ;");
        SwaptionPortfolio_SwaptionRange_builder.append("OS : 19-Jul-2016 / 5.92%     | long     | payer     | #19/Jul/2016#     | #21/Jul/2016#     | #21/Jul/2021#     | 10000000     | 5.92     | Modifiedfollowing     | ACT365F     | S     | EURLIBOR12M     | 0.0002 ;");
        SwaptionPortfolio_SwaptionRange_builder.append("OS : 19-Jul-2017 / 6.06%     | long     | payer     | #19/Jul/2017#     | #21/Jul/2017#     | #21/Jul/2022#     | 10000000     | 6.06     | Modifiedfollowing     | ACT365F     | S     | EURLIBOR12M     | 0.0002 ;");
        SwaptionPortfolio_SwaptionRange_builder.append("OS : 19-Jul-2018 / 6.23%     | long     | payer     | #19/Jul/2018#     | #21/Jul/2018#     | #21/Jul/2023#     | 10000000     | 6.23     | Modifiedfollowing     | ACT365F     | S     | EURLIBOR3M     | 0.0002 ;");
        SwaptionPortfolio_SwaptionRange_builder.append("OS : 19-Jul-2019 / 6.38%     | long     | payer     | #19/Jul/2019#     | #21/Jul/2019#     | #21/Jul/2024#     | 10000000     | 6.38     | Modifiedfollowing     | ACT365F     | S     | EURLIBOR3M     | 0.0002 ;");
        SwaptionPortfolio_SwaptionRange_builder.append("OS : 19-Jul-2020 / 6.51%     | long     | payer     | #19/Jul/2020#     | #21/Jul/2020#     | #21/Jul/2025#     | 10000000     | 6.51     | Modifiedfollowing     | ACT365F     | S     | EURLIBOR6M     | 0.0002 ;");
        SwaptionPortfolio_SwaptionRange_builder.append("OS : 19-Jul-2021 / 6.69%     | long     | payer     | #19/Jul/2021#     | #21/Jul/2021#     | #21/Jul/2026#     | 10000000     | 6.69     | Modifiedfollowing     | ACT365F     | S     | EURLIBOR6M     | 0.0002");
        SwaptionPortfolio_SwaptionRange_builder.append("}");
    
        SwaptionPortfolio_SwaptionRange.RangeFromStr
        (
            SwaptionPortfolio_SwaptionRange_builder.toString()
        );
                                       



    //    Key Handle to be used for the new Portfolio object.
        String MySwaptionPortfolio = "MySwaptionPortfolio" + "_" + Integer.toString(nCTOSPortfolioGlobal);


    //    When creating this object for the first time, set this parameter 
    //    to a positive value.
        int Reload = 1;

    
    //  Excel function call would be this - "CT.BOOK.SwaptionPortfolio()"

    //    Creates a Swaption portfolio object.
        String rSwaptionPortfolio;
                                    
        rSwaptionPortfolio = CTQL.CTOSPortfolioSA.SwaptionPortfolio(
                MySwaptionPortfolio,
                Reload,
                MyGroupedIndex,
                MyYC_XCCY_DCF,
                MySABRVolCurve,
                SwaptionPortfolio_SwaptionRange);


    return rSwaptionPortfolio;

}        








Copyright (c) 2003-2007 CapeTools - All Rights Reserved.