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 Summary
Modifier and TypeFieldDescriptionprotected WeatherLegCalculation
protected CommodityRelativePaymentDates
protected WeatherCalculationPeriods
protected CalculationPeriodsReference
protected WeatherIndexData
protected WeatherIndex
protected NonNegativeMoney
Fields inherited from class net.finmath.smartcontract.product.xml.FinancialSwapLeg
payerAccountReference, payerPartyReference, receiverAccountReference, receiverPartyReference
-
Constructor Summary
-
Method Summary
Modifier 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.void
Sets the value of the calculation property.void
Sets the value of the paymentDates property.void
Sets the value of the weatherCalculationPeriods property.void
Sets the value of the weatherCalculationPeriodsReference property.void
Sets the value of the weatherIndexData property.void
setWeatherIndexLevel
(WeatherIndex value) Sets the value of the weatherIndexLevel property.void
Sets the value of the weatherNotionalAmount property.Methods inherited from class net.finmath.smartcontract.product.xml.FinancialSwapLeg
getPayerAccountReference, getPayerPartyReference, getReceiverAccountReference, getReceiverPartyReference, setPayerAccountReference, setPayerPartyReference, setReceiverAccountReference, setReceiverPartyReference
-
Field Details
-
weatherIndexLevel
-
weatherCalculationPeriods
-
weatherCalculationPeriodsReference
-
weatherNotionalAmount
-
calculation
-
paymentDates
-
weatherIndexData
-
-
Constructor Details
-
WeatherLeg
public WeatherLeg()
-
-
Method Details
-
getWeatherIndexLevel
Gets the value of the weatherIndexLevel property.- Returns:
- possible object is
WeatherIndex
-
setWeatherIndexLevel
Sets the value of the weatherIndexLevel property.- Parameters:
value
- allowed object isWeatherIndex
-
getWeatherCalculationPeriods
Gets the value of the weatherCalculationPeriods property.- Returns:
- possible object is
WeatherCalculationPeriods
-
setWeatherCalculationPeriods
Sets the value of the weatherCalculationPeriods property.- Parameters:
value
- allowed object isWeatherCalculationPeriods
-
getWeatherCalculationPeriodsReference
Gets the value of the weatherCalculationPeriodsReference property.- Returns:
- possible object is
CalculationPeriodsReference
-
setWeatherCalculationPeriodsReference
Sets the value of the weatherCalculationPeriodsReference property.- Parameters:
value
- allowed object isCalculationPeriodsReference
-
getWeatherNotionalAmount
Gets the value of the weatherNotionalAmount property.- Returns:
- possible object is
NonNegativeMoney
-
setWeatherNotionalAmount
Sets the value of the weatherNotionalAmount property.- Parameters:
value
- allowed object isNonNegativeMoney
-
getCalculation
Gets the value of the calculation property.- Returns:
- possible object is
WeatherLegCalculation
-
setCalculation
Sets the value of the calculation property.- Parameters:
value
- allowed object isWeatherLegCalculation
-
getPaymentDates
Gets the value of the paymentDates property.- Returns:
- possible object is
CommodityRelativePaymentDates
-
setPaymentDates
Sets the value of the paymentDates property.- Parameters:
value
- allowed object isCommodityRelativePaymentDates
-
getWeatherIndexData
Gets the value of the weatherIndexData property.- Returns:
- possible object is
WeatherIndexData
-
setWeatherIndexData
Sets the value of the weatherIndexData property.- Parameters:
value
- allowed object isWeatherIndexData
-