/**
 * Copyright (C) 2014 - present by OpenGamma Inc. and the OpenGamma group of companies
 *
 * Please see distribution for license.
 */
package com.opengamma.integration.marketdata.manipulator.dsl;

import java.util.Set;

import com.opengamma.financial.currency.CurrencyPair;
import com.opengamma.util.ArgumentChecker;

/**
 *
 */
public class SpotRateManipulatorBuilder {

  private final Scenario _scenario;
  private final SpotRateSelector _selector;

  public SpotRateManipulatorBuilder(Scenario scenario, SpotRateSelector selector) {
    _scenario = ArgumentChecker.notNull(scenario, "scenario");
    _selector = ArgumentChecker.notNull(selector, "selector");
  }

  /**
   * Shifts the rate by an absolute amount
   * @param shiftAmount The amount of the shift
   * @return This builder
   * @deprecated Use {@link #shift(ScenarioShiftType, Number)}
   */
  @Deprecated
  public SpotRateManipulatorBuilder shift(Number shiftAmount) {
    _scenario.add(_selector, new SpotRateShift(ScenarioShiftType.ABSOLUTE, shiftAmount, _selector.getCurrencyPairs()));
    return this;
  }

  /**
   * Shifts the rate.
   * @param shiftType Whether the shift should be absolute or relative. A relative shift is expressed as an amount
   * to add or subtract, e.g. 10% shift = rate * 1.1, -20% shift = rate * 0.8
   * @param shiftAmount The amount of the shift
   * @return This builder
   */
  public SpotRateManipulatorBuilder shift(ScenarioShiftType shiftType, Number shiftAmount) {
    _scenario.add(_selector, new SpotRateShift(shiftType, shiftAmount, _selector.getCurrencyPairs()));
    return this;
  }

  /**
   * Shifts the rate, ensuring it remains between a specified minimum and maximum value.
   * @param shiftType Whether the shift should be absolute or relative. A relative shift is expressed as an amount
   * to add or subtract, e.g. 10% shift = rate * 1.1, -20% shift = rate * 0.8
   * @param shiftAmount The amount of the shift
   * @param minRate The minimum value allowed for the rate
   * @param maxRate The maximum value allowed for the rate
   * @return This builder
   */
  public SpotRateManipulatorBuilder shift(ScenarioShiftType shiftType, Number shiftAmount, Number minRate, Number maxRate) {
    Set<CurrencyPair> currencyPairs = _selector.getCurrencyPairs();
    if (currencyPairs.size() > 1) {
      throw new IllegalArgumentException("Cannot specify bounds for multiple currency pairs");
    }
    CurrencyPair currencyPair = currencyPairs.iterator().next();
    _scenario.add(_selector, new SpotRateShift(shiftType, shiftAmount, minRate, maxRate, currencyPair));
    return this;
  }

  public SpotRateManipulatorBuilder scaling(Number scalingFactor) {
    _scenario.add(_selector, new SpotRateScaling(scalingFactor, _selector.getCurrencyPairs()));
    return this;
  }

  /**
   * Scales the rate, ensuring it remains between a specified minimum and maximum value.
   * @param scalingFactor The scaling factor to apply to the rate
   * @param minRate The minimum value allowed for the rate
   * @param maxRate The maximum value allowed for the rate
   * @return This builder
   */
  public SpotRateManipulatorBuilder scaling(Number scalingFactor, Number minRate, Number maxRate) {
    Set<CurrencyPair> currencyPairs = _selector.getCurrencyPairs();
    if (currencyPairs.size() > 1) {
      throw new IllegalArgumentException("Cannot specify bounds for multiple currency pairs");
    }
    CurrencyPair currencyPair = currencyPairs.iterator().next();
    _scenario.add(_selector, new SpotRateScaling(scalingFactor, minRate, maxRate, currencyPair));
    return this;
  }

  public SpotRateManipulatorBuilder replace(Number value) {
    _scenario.add(_selector, new SpotRateReplace(value));
    return this;
  }
}