AbstractMetadata.java

/*
 *                  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 static com.google.common.base.Preconditions.checkNotNull;

import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;

import fr.ens.biologie.genomique.eoulsan.util.StringUtils;

/**
 * This abstract class defines methods for metadata.
 * @author Laurent Jourdren
 * @since 2.0
 */

public abstract class AbstractMetadata {

  private Map<String, String> metadata = new LinkedHashMap<>();

  //
  // Methods
  //

  /**
   * Get the value according the key.
   * @param key the key
   * @return the value
   */
  public String get(final String key) {

    checkNotNull(key, "key argument cannot be null");

    return this.metadata.get(key.trim());
  }

  /**
   * Get the trimmed value according the key.
   * @param key the key
   * @return the value
   */
  public String getTrimmed(final String key) {

    final String value = get(key);

    return value != null ? value.trim() : null;
  }

  /**
   * Set the value according the key.
   * @param key the key
   * @param value the value
   */
  public void set(final String key, final String value) {

    checkNotNull(key, "key argument cannot be null");
    checkNotNull(value, "value argument cannot be null");

    this.metadata.put(key, value);
  }

  /**
   * Set the value as a list according the key.
   * @param key the key
   * @param value the value as a list
   */
  public void set(final String key, final List<String> value) {

    checkNotNull(key, "key argument cannot be null");
    checkNotNull(value, "value argument cannot be null");

    switch (value.size()) {

    case 0:
      set(key, "");
      break;

    case 1:
      set(key, value.get(0));
      break;

    default:
      set(key, StringUtils.serializeStringArray(value));
    }
  }

  /**
   * Get the number of metadata.
   * @return the number of metadata
   */
  public int size() {

    return this.metadata.size();
  }

  /**
   * Test if there is no metadata.
   * @return true if there is no metadata
   */
  public boolean isEmpty() {

    return this.metadata.isEmpty();
  }

  /**
   * Test if the key is in md.
   * @param key the key
   * @return true if the key is in md
   */
  public boolean contains(final String key) {

    checkNotNull(key, "key argument cannot be null");

    return this.metadata.containsKey(key.trim());
  }

  /**
   * Get the value according the key as a list.
   * @param key the key
   * @return the value as a list
   */
  public List<String> getAsList(final String key) {

    checkNotNull(key, "key argument cannot be null");

    return StringUtils.deserializeStringArray(get(key.trim()));
  }

  /**
   * Get the value according the key as a boolean.
   * @param key the key
   * @return the value as a boolean
   */
  public boolean getAsBoolean(final String key) {

    checkNotNull(key, "key argument cannot be null");

    return Boolean.parseBoolean(get(key.trim()).toLowerCase());
  }

  /**
   * Get the keys of the metadata
   * @return a set with the keys of the metadata
   */
  public Set<String> keySet() {

    return Collections.unmodifiableSet(this.metadata.keySet());
  }

  /**
   * Get an entry set of the metadata.
   * @return a set of entries
   */
  public Set<Map.Entry<String, String>> entrySet() {

    return Collections.unmodifiableSet(this.metadata.entrySet());
  }

  /**
   * Remove the value according the key.
   * @param key the key
   */
  public void remove(final String key) {

    checkNotNull(key, "key argument cannot be null");

    this.metadata.remove(key.trim());
  }

  //
  // Object methods
  //

  @Override
  public String toString() {

    return com.google.common.base.Objects.toStringHelper(this)
        .add("metadata", this.metadata).toString();
  }

  @Override
  public int hashCode() {

    return Objects.hash(this.metadata);
  }

  @Override
  public boolean equals(final Object o) {

    if (o == this) {
      return true;
    }

    if (!(o instanceof AbstractMetadata)) {
      return false;
    }

    final AbstractMetadata that = (AbstractMetadata) o;

    return Objects.equals(this.metadata, that.metadata);
  }

}