/**
* Copyright (C) 2015 - present by OpenGamma Inc. and the OpenGamma group of companies
*
* Please see distribution for license.
*/
package com.opengamma.strata.pricer.bond;
import java.io.Serializable;
import java.time.LocalDate;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Set;
import org.joda.beans.Bean;
import org.joda.beans.BeanBuilder;
import org.joda.beans.BeanDefinition;
import org.joda.beans.ImmutableBean;
import org.joda.beans.JodaBeanUtils;
import org.joda.beans.MetaProperty;
import org.joda.beans.Property;
import org.joda.beans.PropertyDefinition;
import org.joda.beans.impl.direct.DirectFieldsBeanBuilder;
import org.joda.beans.impl.direct.DirectMetaBean;
import org.joda.beans.impl.direct.DirectMetaProperty;
import org.joda.beans.impl.direct.DirectMetaPropertyMap;
import com.opengamma.strata.basics.currency.Currency;
import com.opengamma.strata.market.param.CurrencyParameterSensitivities;
import com.opengamma.strata.pricer.DiscountFactors;
import com.opengamma.strata.pricer.ZeroRateSensitivity;
/**
* Provides access to discount factors for an issuer curve.
* <p>
* The discount factor represents the time value of money for the specified issuer and currency
* when comparing the valuation date to the specified date.
*/
@BeanDefinition(builderScope = "private")
public final class IssuerCurveDiscountFactors
implements ImmutableBean, Serializable {
/**
* The underlying discount factors for a single currency.
* <p>
* This contains curve, curve currency, valuation date and day count convention.
* The discount factor, its point sensitivity and curve sensitivity are computed by this {@code DiscountFactors}.
*/
@PropertyDefinition(validate = "notNull")
private final DiscountFactors discountFactors;
/**
* The legal entity group.
* <p>
* The group defines the legal entity that the discount factors are for.
*/
@PropertyDefinition(validate = "notNull")
private final LegalEntityGroup legalEntityGroup;
//-------------------------------------------------------------------------
/**
* Obtains an instance based on discount factors and legal entity group.
*
* @param discountFactors the discount factors
* @param legalEntityGroup the legal entity group
* @return the issuer curve discount factors
*/
public static IssuerCurveDiscountFactors of(DiscountFactors discountFactors, LegalEntityGroup legalEntityGroup) {
return new IssuerCurveDiscountFactors(discountFactors, legalEntityGroup);
}
//-------------------------------------------------------------------------
/**
* Gets the currency.
* <p>
* The currency that discount factors are provided for.
*
* @return the currency
*/
public Currency getCurrency() {
return discountFactors.getCurrency();
}
/**
* Gets the valuation date.
* <p>
* The raw data in this provider is calibrated for this date.
*
* @return the valuation date
*/
public LocalDate getValuationDate() {
return discountFactors.getValuationDate();
}
//-------------------------------------------------------------------------
/**
* Gets the discount factor.
* <p>
* The discount factor represents the time value of money for the specified currency and legal entity
* when comparing the valuation date to the specified date.
* <p>
* If the valuation date is on or after the specified date, the discount factor is 1.
*
* @param date the date to discount to
* @return the discount factor
*/
public double discountFactor(LocalDate date) {
return discountFactors.discountFactor(date);
}
/**
* Calculates the zero rate point sensitivity at the specified date.
* <p>
* This returns a sensitivity instance referring to the zero rate sensitivity of the curve
* used to determine the discount factor.
* The sensitivity typically has the value {@code (-discountFactor * relativeYearFraction)}.
* The sensitivity refers to the result of {@link #discountFactor(LocalDate)}.
*
* @param date the date to discount to
* @return the point sensitivity of the zero rate
* @throws RuntimeException if the result cannot be calculated
*/
public IssuerCurveZeroRateSensitivity zeroRatePointSensitivity(LocalDate date) {
return zeroRatePointSensitivity(date, getCurrency());
}
/**
* Calculates the zero rate point sensitivity at the specified date specifying the currency of the sensitivity.
* <p>
* This returns a sensitivity instance referring to the zero rate sensitivity of the curve
* used to determine the discount factor.
* The sensitivity typically has the value {@code (-discountFactor * relativeYearFraction)}.
* The sensitivity refers to the result of {@link #discountFactor(LocalDate)}.
* <p>
* This method allows the currency of the sensitivity to differ from the currency of the curve.
*
* @param date the date to discount to
* @param sensitivityCurrency the currency of the sensitivity
* @return the point sensitivity of the zero rate
* @throws RuntimeException if the result cannot be calculated
*/
public IssuerCurveZeroRateSensitivity zeroRatePointSensitivity(LocalDate date, Currency sensitivityCurrency) {
ZeroRateSensitivity zeroRateSensitivity = discountFactors.zeroRatePointSensitivity(date, sensitivityCurrency);
return IssuerCurveZeroRateSensitivity.of(zeroRateSensitivity, legalEntityGroup);
}
/**
* Calculates the curve parameter sensitivity from the point sensitivity.
* <p>
* This is used to convert a single point sensitivity to curve parameter sensitivity.
* The calculation typically involves multiplying the point and unit sensitivities.
*
* @param pointSensitivity the point sensitivity to convert
* @return the parameter sensitivity
* @throws RuntimeException if the result cannot be calculated
*/
public CurrencyParameterSensitivities parameterSensitivity(IssuerCurveZeroRateSensitivity pointSensitivity) {
return discountFactors.parameterSensitivity(pointSensitivity.createZeroRateSensitivity());
}
//------------------------- AUTOGENERATED START -------------------------
///CLOVER:OFF
/**
* The meta-bean for {@code IssuerCurveDiscountFactors}.
* @return the meta-bean, not null
*/
public static IssuerCurveDiscountFactors.Meta meta() {
return IssuerCurveDiscountFactors.Meta.INSTANCE;
}
static {
JodaBeanUtils.registerMetaBean(IssuerCurveDiscountFactors.Meta.INSTANCE);
}
/**
* The serialization version id.
*/
private static final long serialVersionUID = 1L;
private IssuerCurveDiscountFactors(
DiscountFactors discountFactors,
LegalEntityGroup legalEntityGroup) {
JodaBeanUtils.notNull(discountFactors, "discountFactors");
JodaBeanUtils.notNull(legalEntityGroup, "legalEntityGroup");
this.discountFactors = discountFactors;
this.legalEntityGroup = legalEntityGroup;
}
@Override
public IssuerCurveDiscountFactors.Meta metaBean() {
return IssuerCurveDiscountFactors.Meta.INSTANCE;
}
@Override
public <R> Property<R> property(String propertyName) {
return metaBean().<R>metaProperty(propertyName).createProperty(this);
}
@Override
public Set<String> propertyNames() {
return metaBean().metaPropertyMap().keySet();
}
//-----------------------------------------------------------------------
/**
* Gets the underlying discount factors for a single currency.
* <p>
* This contains curve, curve currency, valuation date and day count convention.
* The discount factor, its point sensitivity and curve sensitivity are computed by this {@code DiscountFactors}.
* @return the value of the property, not null
*/
public DiscountFactors getDiscountFactors() {
return discountFactors;
}
//-----------------------------------------------------------------------
/**
* Gets the legal entity group.
* <p>
* The group defines the legal entity that the discount factors are for.
* @return the value of the property, not null
*/
public LegalEntityGroup getLegalEntityGroup() {
return legalEntityGroup;
}
//-----------------------------------------------------------------------
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj != null && obj.getClass() == this.getClass()) {
IssuerCurveDiscountFactors other = (IssuerCurveDiscountFactors) obj;
return JodaBeanUtils.equal(discountFactors, other.discountFactors) &&
JodaBeanUtils.equal(legalEntityGroup, other.legalEntityGroup);
}
return false;
}
@Override
public int hashCode() {
int hash = getClass().hashCode();
hash = hash * 31 + JodaBeanUtils.hashCode(discountFactors);
hash = hash * 31 + JodaBeanUtils.hashCode(legalEntityGroup);
return hash;
}
@Override
public String toString() {
StringBuilder buf = new StringBuilder(96);
buf.append("IssuerCurveDiscountFactors{");
buf.append("discountFactors").append('=').append(discountFactors).append(',').append(' ');
buf.append("legalEntityGroup").append('=').append(JodaBeanUtils.toString(legalEntityGroup));
buf.append('}');
return buf.toString();
}
//-----------------------------------------------------------------------
/**
* The meta-bean for {@code IssuerCurveDiscountFactors}.
*/
public static final class Meta extends DirectMetaBean {
/**
* The singleton instance of the meta-bean.
*/
static final Meta INSTANCE = new Meta();
/**
* The meta-property for the {@code discountFactors} property.
*/
private final MetaProperty<DiscountFactors> discountFactors = DirectMetaProperty.ofImmutable(
this, "discountFactors", IssuerCurveDiscountFactors.class, DiscountFactors.class);
/**
* The meta-property for the {@code legalEntityGroup} property.
*/
private final MetaProperty<LegalEntityGroup> legalEntityGroup = DirectMetaProperty.ofImmutable(
this, "legalEntityGroup", IssuerCurveDiscountFactors.class, LegalEntityGroup.class);
/**
* The meta-properties.
*/
private final Map<String, MetaProperty<?>> metaPropertyMap$ = new DirectMetaPropertyMap(
this, null,
"discountFactors",
"legalEntityGroup");
/**
* Restricted constructor.
*/
private Meta() {
}
@Override
protected MetaProperty<?> metaPropertyGet(String propertyName) {
switch (propertyName.hashCode()) {
case -91613053: // discountFactors
return discountFactors;
case -899047453: // legalEntityGroup
return legalEntityGroup;
}
return super.metaPropertyGet(propertyName);
}
@Override
public BeanBuilder<? extends IssuerCurveDiscountFactors> builder() {
return new IssuerCurveDiscountFactors.Builder();
}
@Override
public Class<? extends IssuerCurveDiscountFactors> beanType() {
return IssuerCurveDiscountFactors.class;
}
@Override
public Map<String, MetaProperty<?>> metaPropertyMap() {
return metaPropertyMap$;
}
//-----------------------------------------------------------------------
/**
* The meta-property for the {@code discountFactors} property.
* @return the meta-property, not null
*/
public MetaProperty<DiscountFactors> discountFactors() {
return discountFactors;
}
/**
* The meta-property for the {@code legalEntityGroup} property.
* @return the meta-property, not null
*/
public MetaProperty<LegalEntityGroup> legalEntityGroup() {
return legalEntityGroup;
}
//-----------------------------------------------------------------------
@Override
protected Object propertyGet(Bean bean, String propertyName, boolean quiet) {
switch (propertyName.hashCode()) {
case -91613053: // discountFactors
return ((IssuerCurveDiscountFactors) bean).getDiscountFactors();
case -899047453: // legalEntityGroup
return ((IssuerCurveDiscountFactors) bean).getLegalEntityGroup();
}
return super.propertyGet(bean, propertyName, quiet);
}
@Override
protected void propertySet(Bean bean, String propertyName, Object newValue, boolean quiet) {
metaProperty(propertyName);
if (quiet) {
return;
}
throw new UnsupportedOperationException("Property cannot be written: " + propertyName);
}
}
//-----------------------------------------------------------------------
/**
* The bean-builder for {@code IssuerCurveDiscountFactors}.
*/
private static final class Builder extends DirectFieldsBeanBuilder<IssuerCurveDiscountFactors> {
private DiscountFactors discountFactors;
private LegalEntityGroup legalEntityGroup;
/**
* Restricted constructor.
*/
private Builder() {
}
//-----------------------------------------------------------------------
@Override
public Object get(String propertyName) {
switch (propertyName.hashCode()) {
case -91613053: // discountFactors
return discountFactors;
case -899047453: // legalEntityGroup
return legalEntityGroup;
default:
throw new NoSuchElementException("Unknown property: " + propertyName);
}
}
@Override
public Builder set(String propertyName, Object newValue) {
switch (propertyName.hashCode()) {
case -91613053: // discountFactors
this.discountFactors = (DiscountFactors) newValue;
break;
case -899047453: // legalEntityGroup
this.legalEntityGroup = (LegalEntityGroup) newValue;
break;
default:
throw new NoSuchElementException("Unknown property: " + propertyName);
}
return this;
}
@Override
public Builder set(MetaProperty<?> property, Object value) {
super.set(property, value);
return this;
}
@Override
public Builder setString(String propertyName, String value) {
setString(meta().metaProperty(propertyName), value);
return this;
}
@Override
public Builder setString(MetaProperty<?> property, String value) {
super.setString(property, value);
return this;
}
@Override
public Builder setAll(Map<String, ? extends Object> propertyValueMap) {
super.setAll(propertyValueMap);
return this;
}
@Override
public IssuerCurveDiscountFactors build() {
return new IssuerCurveDiscountFactors(
discountFactors,
legalEntityGroup);
}
//-----------------------------------------------------------------------
@Override
public String toString() {
StringBuilder buf = new StringBuilder(96);
buf.append("IssuerCurveDiscountFactors.Builder{");
buf.append("discountFactors").append('=').append(JodaBeanUtils.toString(discountFactors)).append(',').append(' ');
buf.append("legalEntityGroup").append('=').append(JodaBeanUtils.toString(legalEntityGroup));
buf.append('}');
return buf.toString();
}
}
///CLOVER:ON
//-------------------------- AUTOGENERATED END --------------------------
}