CreateVegaReport Example Java





http://www.QuantTools.com
CapeTools IR Risk function list
CreateVegaReport 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 CreateVegaReport() )

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 - CreateVegaReport





    //     ##################################################################################
    //     The first function here CreateVegaReport(), contains a series of
    //     function calls leading upto the main function call, the second function
    //     within this file ( CreateVegaReportPart() ).
    //     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_CreateVegaReport()
{
    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 nCTIRRiskGlobal = 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_CreateVegaReport(String argv[])
    {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
    nCTIRRiskGlobal += 1;
            
    String szErrorMsg = "";

    try
    {



    //    Loads a FX table from a range object into a Exchange Rate Manager 
    //    object.
    

    String MyFXManager;
    MyFXManager = 
        CreateFXManagerPart();
    
    


    //    EURO calendar used for holiday adjustments.
    

    String MyEuroCal;
    MyEuroCal = 
        CALEUROPart();
    
    


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

    String MyCALUKExchange;
    MyCALUKExchange = 
        CALUKExchangePart();
    
    


    //    Creates a centralized valuation date object.
    

    String MyValuationDate;
    MyValuationDate = 
        ValueDateObjPart();
    
    


    //    Generates a schedule of start and end dates, given the initial 
    //    start date and unadjusted final end dates.
    
    String MySchedule;
    MySchedule = 
        MakeSchedulePart(
        MyEuroCal);
    
    


    //    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 SABR curve to model the dynamics of the volatility 
    //    curve (smile).
    
    String MySABRVolCurve;
    MySABRVolCurve = 
        SABRVolCurvePart(
        MyValuationDate,
        MyDepoTPL,
        MySwapTPL);
    
    


    //    Creates an amortisation object to be used within the amortisation 
    //    fixed and floating rate leg objects.
    
    String MyCreateAmortObj;
    MyCreateAmortObj = 
        CreateAmortObjPart(
        MySchedule);
    
    


    //    Creates a yield curve using market rates (No cross-currency 
    //    Swaps).
    
    String MyMiniYC;
    MyMiniYC = 
        MKTYC_D__3Part(
        MyValuationDate,
        MyDepoTPL,
        MySwapTPL);
    
    


    //    Creates a new Index code.
    
    String MyNewIndex2;
    MyNewIndex2 = 
        CreateIndex__2Part(
        MyCALUKExchange,
        MyEuroCal,
        MyMiniYC);
    
    


    //    Creates a market object which is an aggregate of interest rate 
    //    market objects (Discounting curve and Interest rate volatility 
    //    curve (volcurve)).
    
    String MyMarket4;
    MyMarket4 = 
        CreateMKT__4Part(
        MyMiniYC,
        MySABRVolCurve);
    
    


    //    Creates a floating rate leg.
    
    String MyCreateFloatLeg3;
    MyCreateFloatLeg3 = 
        CreateFloatLeg__3Part(
        MySchedule,
        MyNewIndex2,
        MyMarket4);
    
    


    //    Creates an amortised floating rate leg.
    
    String MyCreateAmortFloatLeg2;
    MyCreateAmortFloatLeg2 = 
        CreateAmortFloatLeg__2Part(
        MyCreateAmortObj,
        MyNewIndex2,
        MyMarket4);
    
    


    //    Creates a Fixed rate leg.
    
    String MyCreateFixedRateLeg3;
    MyCreateFixedRateLeg3 = 
        CreateFixedRateLeg__3Part(
        MySchedule,
        MyMarket4);
    
    


    //    This floating leg (or FRN) only provide one payoff.
    
    String MyCreateZCFloatLeg2;
    MyCreateZCFloatLeg2 = 
        CreateZCFloatLeg__2Part(
        MySchedule,
        MyNewIndex2,
        MyMarket4);
    
    


    //    Creates an amortised fixed rate leg.
    
    String MyCreateAmortFixLeg2;
    MyCreateAmortFixLeg2 = 
        CreateAmortFixLeg__2Part(
        MyCreateAmortObj,
        MyMarket4);
    
    


    //    Creates a porfolio of caplet or floorlet options from this floating 
    //    Rate Leg.
    
    String MyCreateCapFLTLeg2;
    MyCreateCapFLTLeg2 = 
        CreateCapFLTLeg__2Part(
        MyCreateFloatLeg3,
        MySABRVolCurve);
    
    


    //    Creates a Structure object (which is really a portfolio of leg 
    //    objects).
    
    String MyStructure;
    MyStructure = 
        CreateStructurePart(
        MyCreateAmortFloatLeg2,
        MyCreateFixedRateLeg3,
        MyCreateZCFloatLeg2,
        MyCreateAmortFixLeg2,
        MyCreateCapFLTLeg2);
    
    


    //    Creates a Vega report object given a Structure object and a 
    //    shift parameter.
    
    String MyVegaReport;
    MyVegaReport = 
        CreateVegaReportPart(
        MyStructure,
        MySABRVolCurve,
        MyFXManager);
    
    // This is the result we are looking for.
    return MyVegaReport;
    
    
    }
    catch(Exception e)
    {
        szErrorMsg = e.getMessage();
        System.exit(1);
    }
                    
}                
        


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

private static String CreateVegaReportPart(
    String MyStructure,
    String MySABRVolCurve,
    String MyFXManager)
{




    //    Key value to use as a handle for the created object
        String MyVegaReport = "MyVegaReport" + "_" + Integer.toString(nCTIRRiskGlobal);


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


    //    The shift that you wish to apply to all points within the VolCurve 
    //    in percent.
        int VolShift = 1;


    //    Currency code that you wish the risk report values to be stored 
    //    in.
        CTIEnums.CCYEnum ReportPVCcy = CTIEnums.CCYEnum.CCY_EUR;

    
    //  Excel function call would be this - "CT.RSK.CreateVegaReport()"

    //    Creates a Vega report object given a Structure object and a 
    //    shift parameter.
        String rCreateVegaReport;
                                    
        rCreateVegaReport = CTQL.CTIRRiskSA.CreateVegaReport(
                MyVegaReport,
                Reload,
                MyStructure,
                MySABRVolCurve,
                VolShift,
                MyFXManager,
                ReportPVCcy);


    return rCreateVegaReport;

}        








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