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

import java.util.LinkedHashMap;
import java.util.Map;

import org.threeten.bp.ZonedDateTime;

import com.google.common.collect.ImmutableMap;
import com.opengamma.core.security.Security;
import com.opengamma.financial.currency.CurrencyPair;
import com.opengamma.sesame.MulticurveBundle;
import com.opengamma.util.ArgumentChecker;

/**
 * Builder for creating a {@link ScenarioMarketDataEnvironment}.
 */
public class ScenarioDataBuilder {

  // linked map so the scenarios are stored in insertion order. do we need to offer other ordering strategies?
  /** Builders for the market data bundle for each scenario. */
  private final Map<String, MarketDataEnvironmentBuilder> _builders = new LinkedHashMap<>();

  /**
   * Adds a multicurve to the market data environment
   *
   * @param scenarioId ID of the scenario to which the multicurve should be added
   * @param name the multicurve name
   * @param multicurve the multicurve
   * @return this builder
   */
  public ScenarioDataBuilder addMulticurve(String scenarioId, String name, MulticurveBundle multicurve) {
    builder(scenarioId).add(MulticurveId.of(name), multicurve);
    return this;
  }

  /**
   * Adds an FX rate to the market data environment
   *
   * @param scenarioId ID of the scenario to which the multicurve should be added
   * @param currencyPair the currency pair
   * @param rate the FX rate for the currency pair
   * @return this builder
   */
  public ScenarioDataBuilder addFxRate(String scenarioId, CurrencyPair currencyPair, double rate) {
    builder(scenarioId).add(FxRateId.of(currencyPair), rate);
    return this;
  }

  /**
   * Adds the market value of a security to the market data environment.
   * <p>
   * The field name {@code Market_Value} is used for the data.
   *
   * @param scenarioId ID of the scenario to which the data should be added
   * @param security the security
   * @param marketValue the security's market value
   * @return this builder
   */
  public ScenarioDataBuilder addSecurityMarketValue(String scenarioId, Security security, double marketValue) {
    builder(scenarioId).add(SecurityId.of(security), marketValue);
    return this;
  }

  /**
   * Adds a value for a security to the market data environment.
   *
   * @param scenarioId ID of the scenario to which the data should be added
   * @param security the security
   * @param fieldName the field name in the market data record containing the value
   * @param value the value
   * @return this builder
   */
  public ScenarioDataBuilder addSecurityValue(String scenarioId, Security security, FieldName fieldName, double value) {
    builder(scenarioId).add(SecurityId.of(security, Double.class, fieldName), value);
    return this;
  }

  /**
   * Adds a value for a security to the market data environment.
   *
   * @param scenarioId ID of the scenario to which the data should be added
   * @param security the security
   * @param fieldName the field name in the market data record containing the value
   * @param value the value
   * @return this builder
   */
  public ScenarioDataBuilder addSecurityValue(String scenarioId, Security security, FieldName fieldName, Object value) {
    ArgumentChecker.notNull(value, "value");
    builder(scenarioId).add(SecurityId.of(security, value.getClass(), fieldName), value);
    return this;
  }

  /**
   * Sets the valuation time for a scenario.
   *
   * @param scenarioId ID of the scenario
   * @param valuationTime the valuation time for the scenario
   * @return this builder
   */
  public ScenarioDataBuilder valuationTime(String scenarioId, ZonedDateTime valuationTime) {
    builder(scenarioId).valuationTime(valuationTime);
    return this;
  }

  /**
   * Returns the bundle builder for a scenario, creating it if necessary
   *
   * @param scenarioId ID of the scenario
   * @return the bundle builder for a scenario
   */
  private MarketDataEnvironmentBuilder builder(String scenarioId) {
    MarketDataEnvironmentBuilder builder = _builders.get(scenarioId);

    if (builder != null) {
      return builder;
    }
    MarketDataEnvironmentBuilder newBuilder = new MarketDataEnvironmentBuilder();
    _builders.put(scenarioId, newBuilder);
    return newBuilder;
  }

  /**
   * Builds a market data environment from the data in this builder.
   *
   * @return a market data environment built from the data in this builder
   */
  public ScenarioMarketDataEnvironment build() {
    ImmutableMap.Builder<String, MarketDataEnvironment> scenarioData = ImmutableMap.builder();

    for (Map.Entry<String, MarketDataEnvironmentBuilder> entry : _builders.entrySet()) {
      String scenarioId = entry.getKey();
      MarketDataEnvironmentBuilder bundleBuilder = entry.getValue();
      scenarioData.put(scenarioId, bundleBuilder.build());
    }
    return new MapScenarioMarketDataEnvironment(scenarioData.build());
  }
}