/*
 *                  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.design;

import java.io.Serializable;

/**
 * This class defines the experiment sample metadata.
 * @author Xavier Bauquet
 * @since 2.0
 */

public class ExperimentSampleMetadata extends AbstractMetadata
    implements Serializable {

  /** Serialization version UID. */
  private static final long serialVersionUID = 4079804296437126108L;

  // constants
  public static final String REP_TECH_GROUP_KEY = "RepTechGroup";
  public static final String REFERENCE_KEY = "Reference";
  public static final String CONDITION_KEY = "Condition";

  //
  // Getters
  //

  /**
   * Get the RepTechGroup.
   * @return the RepTechGroup
   */
  public String getRepTechGroup() {
    return getTrimmed(REP_TECH_GROUP_KEY);
  }

  /**
   * Get the reference.
   * @return the reference
   */
  public String getReference() {
    return getTrimmed(REFERENCE_KEY);
  }

  /**
   * Get the reference.
   * @return the reference
   */
  public boolean isReference() {

    String value = getReference();

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

    value = value.trim().toLowerCase();

    return "t".equals(value)
        || "true".equals(value) || "y".equals(value) || "yes".equals(value);
  }

  /**
   * Get the condition.
   * @return the condition
   */
  public String getCondition() {
    return get(CONDITION_KEY);
  }

  //
  // Setters
  //

  /**
   * Set the ReptechGroup.
   * @param newReptechGroup the new ReptechGroup
   */
  public void setRepTechGroup(final String newReptechGroup) {
    set(REP_TECH_GROUP_KEY, newReptechGroup);
  }

  /**
   * Set the reference.
   * @param newReference the new reference
   */
  public void setReference(final boolean newReference) {
    setReference(Boolean.toString(newReference));
  }

  /**
   * Set the reference.
   * @param newReference the new reference
   */
  public void setReference(final String newReference) {
    set(REFERENCE_KEY, newReference);
  }

  /**
   * Set the condition.
   * @param newCondition the new condition
   */
  public void setCondition(final String newCondition) {
    set(CONDITION_KEY, newCondition);
  }

  //
  // Contains
  //

  /**
   * Test if the RepTechGroup field exists.
   * @return true if the RepTechGroup field exists
   */
  public boolean containsRepTechGroup() {
    return contains(REP_TECH_GROUP_KEY);
  }

  /**
   * Test if the reference field exists.
   * @return true if the reference field exists
   */
  public boolean containsReference() {
    return contains(REFERENCE_KEY);
  }

  /**
   * Test if the condition field exists.
   * @return true if the condition field exists
   */
  public boolean containsCondition() {
    return contains(CONDITION_KEY);
  }

  //
  // Constructor
  //

  public ExperimentSampleMetadata() {
  }
}