/*
 *                  Eoulsan development code
 *
 * This code may be freely distributed and modified under the
 * terms of the GNU Lesser General Public License version 2.1 or
 * later and CeCILL-C. This should be distributed with the code.
 * If you do not have a copy, see:
 *
 *      http://www.gnu.org/licenses/lgpl-2.1.txt
 *      http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.txt
 *
 * Copyright for this code is held jointly by the Genomic platform
 * of the Institut de Biologie de l'École normale supérieure and
 * the individual authors. These should be listed in @author doc
 * comments.
 *
 * For more information on the Eoulsan project and its aims,
 * or to join the Eoulsan Google group, visit the home page
 * at:
 *
 *      http://outils.genomique.biologie.ens.fr/eoulsan
 *
 */

package fr.ens.biologie.genomique.eoulsan.translators;

import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

/**
 * This class define a translator composed of several translators.
 * @since 2.0
 * @author Laurent Jourdren
 */
public class ConcatTranslator extends AbstractTranslator {

  private final Map<String, Translator> translators = new LinkedHashMap<>();

  /**
   * Get an ordered list of the translator fields
   * @return an ordered list of the translator fields.
   */
  @Override
  public List<String> getFields() {

    return new ArrayList<>(this.translators.keySet());
  }

  /**
   * Get a translation for a feature
   * @param id Identifier of the feature
   * @param field the field to get
   * @return An array with the annotation of the Feature
   */
  @Override
  public String translateField(final String id, final String field) {

    Translator t = this.translators.get(field);

    if (t == null) {
      throw new NullPointerException("Associated Translator t is null.");
    }

    return t.translateField(id, field);
  }

  /**
   * Test if the link information is available for the field
   * @param field Field to test
   * @return true if link information is available
   */
  @Override
  public boolean isLinkInfo(final String field) {

    Translator t = this.translators.get(field);

    if (t == null) {
      return false;
    }

    return t.isLinkInfo(field);
  }

  /**
   * Get link information.
   * @param translatedId Translated id
   * @param field field of the id
   * @return a link for the translated id
   */
  @Override
  public String getLinkInfo(final String translatedId, final String field) {

    Translator t = this.translators.get(field);

    if (t == null) {
      return null;
    }

    return t.getLinkInfo(translatedId, field);
  }

  /**
   * Add a translator to the concat translator.
   * @param translator Translator to add
   */
  public void addTranslator(final Translator translator) {

    if (translator == null) {
      return;
    }

    final List<String> fields = translator.getFields();

    if (fields == null) {
      return;
    }

    for (final String key : fields) {

      if (!this.translators.containsKey(key)) {
        this.translators.put(key, translator);
      }
    }
  }

  //
  // Constructors
  //

  /**
   * Public constructor.
   */
  public ConcatTranslator() {
  }

  /**
   * Public constructor.
   * @param translator1 first translator to add
   * @param translator2 first translator to add
   */
  public ConcatTranslator(final Translator translator1,
      final Translator translator2) {

    addTranslator(translator1);
    addTranslator(translator2);
  }

}