net.finmath.montecarlo.interestrate.products.components

Class ProductCollection

java.lang.Object

net.finmath.montecarlo.AbstractMonteCarloProduct

net.finmath.montecarlo.interestrate.products.AbstractLIBORMonteCarloProduct

net.finmath.montecarlo.interestrate.products.components.AbstractProductComponent

net.finmath.montecarlo.interestrate.products.components.ProductCollection

All Implemented Interfaces:

java.io.Serializable, ProductInterface

public class ProductCollection
extends AbstractProductComponent

A collection of product components (like periods, options, etc.) paying the sum of their payouts.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProductCollection(AbstractProductComponent... products) Creates a collection of product components paying the sum of their payouts.
ProductCollection(java.util.Collection<AbstractProductComponent> products) Creates a collection of product components paying the sum of their payouts.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCurrency() Returns the currency string of this notional.
java.util.Collection<AbstractProductComponent>	getProducts() Returns the collection containing all products as an unmodifiable collection.
RandomVariableInterface	getValue(double evaluationTime, LIBORModelMonteCarloSimulationInterface model) This method returns the value random variable of the product within the specified model, evaluated at a given evalutationTime.
java.util.Set<java.lang.String>	queryUnderlyings() Returns a set of underlying names referenced by this product component (i.e., required for valuation) or null if none.
java.lang.String	toString()

Methods inherited from class net.finmath.montecarlo.interestrate.products.components.AbstractProductComponent

getValues

Methods inherited from class net.finmath.montecarlo.interestrate.products.AbstractLIBORMonteCarloProduct

getFactorDrift, getValue, getValueForModifiedData

Methods inherited from class net.finmath.montecarlo.AbstractMonteCarloProduct

getValue, getValue, getValues, getValues, getValuesForModifiedData, getValuesForModifiedData, getValuesForModifiedData, getValuesForModifiedData

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ProductCollection

public ProductCollection(AbstractProductComponent... products)

Creates a collection of product components paying the sum of their payouts.

Parameters:

products - Array of AbstractProductComponent objects

ProductCollection

public ProductCollection(java.util.Collection<AbstractProductComponent> products)

Creates a collection of product components paying the sum of their payouts.

Parameters:

products - Collection of AbstractProductComponent objects

Method Detail

getCurrency

public java.lang.String getCurrency()

Description copied from class: AbstractMonteCarloProduct

Returns the currency string of this notional.

Overrides:

getCurrency in class AbstractMonteCarloProduct

Returns:

the currency

getProducts

public java.util.Collection<AbstractProductComponent> getProducts()

Returns the collection containing all products as an unmodifiable collection.

Returns:

the collection containing all products.

queryUnderlyings

public java.util.Set<java.lang.String> queryUnderlyings()

Description copied from class: AbstractProductComponent

Returns a set of underlying names referenced by this product component (i.e., required for valuation) or null if none.

Specified by:

queryUnderlyings in class AbstractProductComponent

Returns:

A set of underlying names referenced by this product component (i.e., required for valuation) or null if none.

getValue

public RandomVariableInterface getValue(double evaluationTime,
                                        LIBORModelMonteCarloSimulationInterface model)
                                 throws CalculationException

This method returns the value random variable of the product within the specified model, evaluated at a given evalutationTime. Note: For a lattice this is often the value conditional to evalutationTime, for a Monte-Carlo simulation this is the (sum of) value discounted to evaluation time. Cashflows prior evaluationTime are not considered.

Specified by:

getValue in class AbstractLIBORMonteCarloProduct

Parameters:

evaluationTime - The time on which this products value should be observed.

model - The model used to price the product.

Returns:

The random variable representing the value of the product discounted to evaluation time

Throws:

CalculationException - Thrown if the valuation fails, specific cause may be available via the cause() method.

See Also:

AbstractMonteCarloProduct.getValue(double, net.finmath.montecarlo.MonteCarloSimulationInterface)

toString

public java.lang.String toString()

Overrides:

toString in class AbstractMonteCarloProduct