org.pharmgkb.parser.vcf.model.IdDescriptionMetadata Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vcf-parser Show documentation

A strict streaming parser for VCF 4.1/4.2.

The newest version!

package org.pharmgkb.parser.vcf.model;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.lang.invoke.MethodHandles;
import java.util.Map;


/**
 * This class represents a single VCF metadata line with an id and description.
 * 
 * In 4.1/4.2:
 * 
{@code
 * ##ALT=
 * ##FILTER=
 * }
 * 
 *
 * @author Mark Woon
 */
public class IdDescriptionMetadata extends IdMetadata {

  private static final Logger sf_logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());

  public static final String ID = "ID";
  public static final String DESCRIPTION = "Description";

  public IdDescriptionMetadata(@Nonnull String id, @Nonnull String description) {
    this(id, description, true);
  }

  public IdDescriptionMetadata(@Nonnull Map properties, boolean isBaseType) {
    super(properties, false);
    init(isBaseType);
  }

  protected IdDescriptionMetadata(@Nonnull String id, @Nonnull String description, boolean isBaseType) {
    super(id);
    putAndQuoteProperty(DESCRIPTION, description);
    init(isBaseType);
  }

  private void init(boolean isBaseType) {
    if (getPropertyRaw(DESCRIPTION) == null) {
      sf_logger.warn("Required metadata property \"{}\" is missing", DESCRIPTION);
    }
    if (isBaseType) {
      ensureNoExtras(ID, DESCRIPTION);
    }
  }

  /**
   * @return Null only when incorrectly constructed without one
   */
  @Nullable
  public String getDescription() {
    return getPropertyUnquoted(DESCRIPTION);
  }


}