Class WeatherLeg
java.lang.Object
net.finmath.smartcontract.product.xml.Leg
net.finmath.smartcontract.product.xml.CommoditySwapLeg
net.finmath.smartcontract.product.xml.FinancialSwapLeg
net.finmath.smartcontract.product.xml.WeatherLeg
A weather leg of a Commodity Swap defines Weather Index Swap transactions.
                 Weather Index Swap transactions are OTC derivative transactions which settle financially based on an
                 index calculated from observations of temperature, precipitation and other weather-related measurements
                 at weather stations throughout the world. Sub-Annex C of the 2005 ISDA Commodity Definitions provides
                 definitions and terms for a number of types of weather indices. These indices include: HDD (heating
                 degree days), CDD (cooling degree days), CPD (critical precipitation days). Weather Index Swap
                 transactions result in a cash flow to one of the two counterparties each Calculation Period depending on
                 the relationship between the Settlement Level and the Weather Index Level. A Weather Index swap
                 transaction always consists of a commodity swap element as a parent to two weatherLeg elements.
             
 
 
Java class for WeatherLeg complex type.
The following schema fragment specifies the expected content contained within this class.
 <complexType name="WeatherLeg">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}FinancialSwapLeg">
       <sequence>
         <element name="weatherIndexLevel" type="{http://www.fpml.org/FpML-5/confirmation}WeatherIndex"/>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}WeatherCalculationPeriod.model"/>
         <element name="weatherNotionalAmount" type="{http://www.fpml.org/FpML-5/confirmation}NonNegativeMoney"/>
         <element name="calculation" type="{http://www.fpml.org/FpML-5/confirmation}WeatherLegCalculation"/>
         <element name="paymentDates" type="{http://www.fpml.org/FpML-5/confirmation}CommodityRelativePaymentDates"/>
         <element name="weatherIndexData" type="{http://www.fpml.org/FpML-5/confirmation}WeatherIndexData"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 - 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected WeatherLegCalculationprotected CommodityRelativePaymentDatesprotected WeatherCalculationPeriodsprotected CalculationPeriodsReferenceprotected WeatherIndexDataprotected WeatherIndexprotected NonNegativeMoneyFields inherited from class net.finmath.smartcontract.product.xml.FinancialSwapLegpayerAccountReference, payerPartyReference, receiverAccountReference, receiverPartyReference
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionGets the value of the calculation property.Gets the value of the paymentDates property.Gets the value of the weatherCalculationPeriods property.Gets the value of the weatherCalculationPeriodsReference property.Gets the value of the weatherIndexData property.Gets the value of the weatherIndexLevel property.Gets the value of the weatherNotionalAmount property.voidsetCalculation(WeatherLegCalculation value)Sets the value of the calculation property.voidSets the value of the paymentDates property.voidSets the value of the weatherCalculationPeriods property.voidSets the value of the weatherCalculationPeriodsReference property.voidsetWeatherIndexData(WeatherIndexData value)Sets the value of the weatherIndexData property.voidsetWeatherIndexLevel(WeatherIndex value)Sets the value of the weatherIndexLevel property.voidSets the value of the weatherNotionalAmount property.Methods inherited from class net.finmath.smartcontract.product.xml.FinancialSwapLeggetPayerAccountReference, getPayerPartyReference, getReceiverAccountReference, getReceiverPartyReference, setPayerAccountReference, setPayerPartyReference, setReceiverAccountReference, setReceiverPartyReference
- 
Field Details- 
weatherIndexLevel
- 
weatherCalculationPeriods
- 
weatherCalculationPeriodsReference
- 
weatherNotionalAmount
- 
calculation
- 
paymentDates
- 
weatherIndexData
 
- 
- 
Constructor Details- 
WeatherLegpublic WeatherLeg()
 
- 
- 
Method Details- 
getWeatherIndexLevelGets the value of the weatherIndexLevel property.- Returns:
- possible object is
     WeatherIndex
 
- 
setWeatherIndexLevelSets the value of the weatherIndexLevel property.- Parameters:
- value- allowed object is- WeatherIndex
 
- 
getWeatherCalculationPeriodsGets the value of the weatherCalculationPeriods property.- Returns:
- possible object is
     WeatherCalculationPeriods
 
- 
setWeatherCalculationPeriodsSets the value of the weatherCalculationPeriods property.- Parameters:
- value- allowed object is- WeatherCalculationPeriods
 
- 
getWeatherCalculationPeriodsReferenceGets the value of the weatherCalculationPeriodsReference property.- Returns:
- possible object is
     CalculationPeriodsReference
 
- 
setWeatherCalculationPeriodsReferenceSets the value of the weatherCalculationPeriodsReference property.- Parameters:
- value- allowed object is- CalculationPeriodsReference
 
- 
getWeatherNotionalAmountGets the value of the weatherNotionalAmount property.- Returns:
- possible object is
     NonNegativeMoney
 
- 
setWeatherNotionalAmountSets the value of the weatherNotionalAmount property.- Parameters:
- value- allowed object is- NonNegativeMoney
 
- 
getCalculationGets the value of the calculation property.- Returns:
- possible object is
     WeatherLegCalculation
 
- 
setCalculationSets the value of the calculation property.- Parameters:
- value- allowed object is- WeatherLegCalculation
 
- 
getPaymentDatesGets the value of the paymentDates property.- Returns:
- possible object is
     CommodityRelativePaymentDates
 
- 
setPaymentDatesSets the value of the paymentDates property.- Parameters:
- value- allowed object is- CommodityRelativePaymentDates
 
- 
getWeatherIndexDataGets the value of the weatherIndexData property.- Returns:
- possible object is
     WeatherIndexData
 
- 
setWeatherIndexDataSets the value of the weatherIndexData property.- Parameters:
- value- allowed object is- WeatherIndexData
 
 
-