com.opengamma.strata.calc.CalculationRules Maven / Gradle / Ivy
Show all versions of strata-calc Show documentation
/*
* Copyright (C) 2015 - present by OpenGamma Inc. and the OpenGamma group of companies
*
* Please see distribution for license.
*/
package com.opengamma.strata.calc;
import java.util.Map;
import java.util.NoSuchElementException;
import org.joda.beans.Bean;
import org.joda.beans.BeanBuilder;
import org.joda.beans.ImmutableBean;
import org.joda.beans.JodaBeanUtils;
import org.joda.beans.MetaBean;
import org.joda.beans.MetaProperty;
import org.joda.beans.gen.BeanDefinition;
import org.joda.beans.gen.ImmutableDefaults;
import org.joda.beans.gen.PropertyDefinition;
import org.joda.beans.impl.direct.DirectMetaBean;
import org.joda.beans.impl.direct.DirectMetaProperty;
import org.joda.beans.impl.direct.DirectMetaPropertyMap;
import org.joda.beans.impl.direct.DirectPrivateBeanBuilder;
import com.opengamma.strata.basics.currency.Currency;
import com.opengamma.strata.calc.runner.CalculationFunction;
import com.opengamma.strata.calc.runner.CalculationFunctions;
import com.opengamma.strata.calc.runner.CalculationParameter;
import com.opengamma.strata.calc.runner.CalculationParameters;
/**
* A set of rules that define how the calculation runner should perform calculations.
*
* {@link CalculationRunner} provides the ability to perform calculations on many targets,
* such as trades and positions. It returns a grid of results, with the targets as rows.
* Each individual calculation is controlled by three things:
*
* - The {@linkplain CalculationFunction function}, selected by the target type
* - The {@linkplain Measure measure}, the high-level output to be calculated
* - The {@linkplain CalculationParameters parameters}, adjust how the measure is to be calculated
*
* {@code CalculationRules} operates in association with {@link Column}.
* The column is used to define the measure. It can also be used to specify column-specific parameters.
* The rules contain the complete set of functions and the default set of parameters.
*/
@BeanDefinition(builderScope = "private")
public final class CalculationRules implements ImmutableBean {
/**
* The calculation functions.
*
* Functions provide the logic of the calculation.
* Each type of target must have an associated function in order for calculations to be performed.
*/
@PropertyDefinition(validate = "notNull")
private final CalculationFunctions functions;
/**
* The reporting currency, used to control currency conversion.
*
* This is used to specify the currency that the result should be reporting in.
* If the result is not associated with a currency, such as for "par rate", then the
* reporting currency will effectively be ignored.
*/
@PropertyDefinition(validate = "notNull")
private final ReportingCurrency reportingCurrency;
/**
* The calculation parameters, used to control the how the calculation is performed.
*
* Parameters are used to parameterize the {@link Measure} to be calculated.
* They may be specified in two places - here and in the {@link Column}.
* The parameters specified here are the defaults that apply to all columns.
*
* If a parameter is defined here and in the column with the same
* {@linkplain CalculationParameter#queryType() query type}, then the column parameter takes precedence.
*/
@PropertyDefinition(validate = "notNull")
private final CalculationParameters parameters;
//-------------------------------------------------------------------------
/**
* Obtains an instance specifying the functions to use and some additional parameters.
*
* The output will uses the "natural" {@linkplain ReportingCurrency reporting currency}.
* Most functions require a parameter to control their behavior, such as {@code RatesMarketDataLookup}.
*
* @param functions the calculation functions
* @param parameters the parameters that control the calculation, may be empty
* @return the rules
*/
public static CalculationRules of(CalculationFunctions functions, CalculationParameter... parameters) {
CalculationParameters params = CalculationParameters.of(parameters);
return new CalculationRules(functions, ReportingCurrency.NATURAL, params);
}
/**
* Obtains an instance specifying the functions to use and some additional parameters.
*
* The output will uses the "natural" {@linkplain ReportingCurrency reporting currency}.
* Most functions require a parameter to control their behavior, such as {@code RatesMarketDataLookup}.
*
* @param functions the calculation functions
* @param parameters the parameters that control the calculation, may be empty
* @return the rules
*/
public static CalculationRules of(CalculationFunctions functions, CalculationParameters parameters) {
return new CalculationRules(functions, ReportingCurrency.NATURAL, parameters);
}
/**
* Obtains an instance specifying the functions, reporting currency and additional parameters.
*
* Most functions require a parameter to control their behavior, such as {@code RatesMarketDataLookup}.
*
* @param functions the calculation functions
* @param reportingCurrency the reporting currency
* @param parameters the parameters that control the calculation, may be empty
* @return the rules
*/
public static CalculationRules of(
CalculationFunctions functions,
Currency reportingCurrency,
CalculationParameter... parameters) {
CalculationParameters params = CalculationParameters.of(parameters);
return new CalculationRules(functions, ReportingCurrency.of(reportingCurrency), params);
}
/**
* Obtains an instance specifying the functions, reporting currency and additional parameters.
*
* Most functions require a parameter to control their behavior, such as {@code RatesMarketDataLookup}.
*
* @param functions the calculation functions
* @param reportingCurrency the reporting currency
* @param parameters the parameters that control the calculation, may be empty
* @return the rules
*/
public static CalculationRules of(
CalculationFunctions functions,
ReportingCurrency reportingCurrency,
CalculationParameters parameters) {
return new CalculationRules(functions, reportingCurrency, parameters);
}
@ImmutableDefaults
private static void applyDefaults(Builder builder) {
builder.parameters = CalculationParameters.empty();
}
//------------------------- AUTOGENERATED START -------------------------
/**
* The meta-bean for {@code CalculationRules}.
* @return the meta-bean, not null
*/
public static CalculationRules.Meta meta() {
return CalculationRules.Meta.INSTANCE;
}
static {
MetaBean.register(CalculationRules.Meta.INSTANCE);
}
private CalculationRules(
CalculationFunctions functions,
ReportingCurrency reportingCurrency,
CalculationParameters parameters) {
JodaBeanUtils.notNull(functions, "functions");
JodaBeanUtils.notNull(reportingCurrency, "reportingCurrency");
JodaBeanUtils.notNull(parameters, "parameters");
this.functions = functions;
this.reportingCurrency = reportingCurrency;
this.parameters = parameters;
}
@Override
public CalculationRules.Meta metaBean() {
return CalculationRules.Meta.INSTANCE;
}
//-----------------------------------------------------------------------
/**
* Gets the calculation functions.
*
* Functions provide the logic of the calculation.
* Each type of target must have an associated function in order for calculations to be performed.
* @return the value of the property, not null
*/
public CalculationFunctions getFunctions() {
return functions;
}
//-----------------------------------------------------------------------
/**
* Gets the reporting currency, used to control currency conversion.
*
* This is used to specify the currency that the result should be reporting in.
* If the result is not associated with a currency, such as for "par rate", then the
* reporting currency will effectively be ignored.
* @return the value of the property, not null
*/
public ReportingCurrency getReportingCurrency() {
return reportingCurrency;
}
//-----------------------------------------------------------------------
/**
* Gets the calculation parameters, used to control the how the calculation is performed.
*
* Parameters are used to parameterize the {@link Measure} to be calculated.
* They may be specified in two places - here and in the {@link Column}.
* The parameters specified here are the defaults that apply to all columns.
*
* If a parameter is defined here and in the column with the same
* {@linkplain CalculationParameter#queryType() query type}, then the column parameter takes precedence.
* @return the value of the property, not null
*/
public CalculationParameters getParameters() {
return parameters;
}
//-----------------------------------------------------------------------
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj != null && obj.getClass() == this.getClass()) {
CalculationRules other = (CalculationRules) obj;
return JodaBeanUtils.equal(functions, other.functions) &&
JodaBeanUtils.equal(reportingCurrency, other.reportingCurrency) &&
JodaBeanUtils.equal(parameters, other.parameters);
}
return false;
}
@Override
public int hashCode() {
int hash = getClass().hashCode();
hash = hash * 31 + JodaBeanUtils.hashCode(functions);
hash = hash * 31 + JodaBeanUtils.hashCode(reportingCurrency);
hash = hash * 31 + JodaBeanUtils.hashCode(parameters);
return hash;
}
@Override
public String toString() {
StringBuilder buf = new StringBuilder(128);
buf.append("CalculationRules{");
buf.append("functions").append('=').append(JodaBeanUtils.toString(functions)).append(',').append(' ');
buf.append("reportingCurrency").append('=').append(JodaBeanUtils.toString(reportingCurrency)).append(',').append(' ');
buf.append("parameters").append('=').append(JodaBeanUtils.toString(parameters));
buf.append('}');
return buf.toString();
}
//-----------------------------------------------------------------------
/**
* The meta-bean for {@code CalculationRules}.
*/
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 functions} property.
*/
private final MetaProperty functions = DirectMetaProperty.ofImmutable(
this, "functions", CalculationRules.class, CalculationFunctions.class);
/**
* The meta-property for the {@code reportingCurrency} property.
*/
private final MetaProperty reportingCurrency = DirectMetaProperty.ofImmutable(
this, "reportingCurrency", CalculationRules.class, ReportingCurrency.class);
/**
* The meta-property for the {@code parameters} property.
*/
private final MetaProperty parameters = DirectMetaProperty.ofImmutable(
this, "parameters", CalculationRules.class, CalculationParameters.class);
/**
* The meta-properties.
*/
private final Map> metaPropertyMap$ = new DirectMetaPropertyMap(
this, null,
"functions",
"reportingCurrency",
"parameters");
/**
* Restricted constructor.
*/
private Meta() {
}
@Override
protected MetaProperty metaPropertyGet(String propertyName) {
switch (propertyName.hashCode()) {
case -140572773: // functions
return functions;
case -1287844769: // reportingCurrency
return reportingCurrency;
case 458736106: // parameters
return parameters;
}
return super.metaPropertyGet(propertyName);
}
@Override
public BeanBuilder builder() {
return new CalculationRules.Builder();
}
@Override
public Class beanType() {
return CalculationRules.class;
}
@Override
public Map> metaPropertyMap() {
return metaPropertyMap$;
}
//-----------------------------------------------------------------------
/**
* The meta-property for the {@code functions} property.
* @return the meta-property, not null
*/
public MetaProperty functions() {
return functions;
}
/**
* The meta-property for the {@code reportingCurrency} property.
* @return the meta-property, not null
*/
public MetaProperty reportingCurrency() {
return reportingCurrency;
}
/**
* The meta-property for the {@code parameters} property.
* @return the meta-property, not null
*/
public MetaProperty parameters() {
return parameters;
}
//-----------------------------------------------------------------------
@Override
protected Object propertyGet(Bean bean, String propertyName, boolean quiet) {
switch (propertyName.hashCode()) {
case -140572773: // functions
return ((CalculationRules) bean).getFunctions();
case -1287844769: // reportingCurrency
return ((CalculationRules) bean).getReportingCurrency();
case 458736106: // parameters
return ((CalculationRules) bean).getParameters();
}
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 CalculationRules}.
*/
private static final class Builder extends DirectPrivateBeanBuilder {
private CalculationFunctions functions;
private ReportingCurrency reportingCurrency;
private CalculationParameters parameters;
/**
* Restricted constructor.
*/
private Builder() {
applyDefaults(this);
}
//-----------------------------------------------------------------------
@Override
public Object get(String propertyName) {
switch (propertyName.hashCode()) {
case -140572773: // functions
return functions;
case -1287844769: // reportingCurrency
return reportingCurrency;
case 458736106: // parameters
return parameters;
default:
throw new NoSuchElementException("Unknown property: " + propertyName);
}
}
@Override
public Builder set(String propertyName, Object newValue) {
switch (propertyName.hashCode()) {
case -140572773: // functions
this.functions = (CalculationFunctions) newValue;
break;
case -1287844769: // reportingCurrency
this.reportingCurrency = (ReportingCurrency) newValue;
break;
case 458736106: // parameters
this.parameters = (CalculationParameters) newValue;
break;
default:
throw new NoSuchElementException("Unknown property: " + propertyName);
}
return this;
}
@Override
public CalculationRules build() {
return new CalculationRules(
functions,
reportingCurrency,
parameters);
}
//-----------------------------------------------------------------------
@Override
public String toString() {
StringBuilder buf = new StringBuilder(128);
buf.append("CalculationRules.Builder{");
buf.append("functions").append('=').append(JodaBeanUtils.toString(functions)).append(',').append(' ');
buf.append("reportingCurrency").append('=').append(JodaBeanUtils.toString(reportingCurrency)).append(',').append(' ');
buf.append("parameters").append('=').append(JodaBeanUtils.toString(parameters));
buf.append('}');
return buf.toString();
}
}
//-------------------------- AUTOGENERATED END --------------------------
}