org.dishevelled.bio.assembly.gfa2.Header Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dsh-bio-assembly Show documentation
Assemblies.
The newest version!
/*

    dsh-bio-assembly  Assemblies.
    Copyright (c) 2013-2024 held jointly by the individual authors.

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Lesser General Public License as published
    by the Free Software Foundation; either version 3 of the License, or (at
    your option) any later version.

    This library is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
    License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this library;  if not, write to the Free Software Foundation,
    Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA.

    > http://www.fsf.org/licensing/licenses/lgpl.html
    > http://www.opensource.org/licenses/lgpl-license.php

*/
package org.dishevelled.bio.assembly.gfa2;

import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;

import java.util.List;
import java.util.Map;
import java.util.Optional;

import javax.annotation.concurrent.Immutable;

import com.google.common.base.Joiner;
import com.google.common.base.Splitter;

import com.google.common.collect.ImmutableMap;

import org.dishevelled.bio.annotation.Annotation;

/**
 * Header GFA 2.0 record.
 *
 * @author  Michael Heuer
 */
@Immutable
public final class Header extends Gfa2Record {

    /**
     * Create a new header GFA 2.0 record.
     *
     * @param annotations annotations, must not be null
     */
    public Header(final Map annotations) {
        super(annotations);
    }


    // optional fields

    /**
     * Return true if the annotations for this header contain
     * the reserved key TS.
     *
     * @since 1.3.2
     * @return true if the annotations for this header contain
     *    the reserved key TS
     */
    public boolean containsTs() {
        return containsAnnotationKey("TS");
    }

    /**
     * Return the Type=i value for the reserved key TS
     * as an integer.
     *
     * @since 1.3.2
     * @return the Type=i value for the reserved key TS
     *    as an integer
     */
    public int getTs() {
        return getAnnotationInteger("TS");
    }

    /**
     * Return an optional Type=i value for the reserved key TS
     * as an integer.
     *
     * @since 1.3.2
     * @return an optional Type=i value for the reserved key TS
     *   as an integer
     */
    public Optional getTsOpt() {
        return getAnnotationIntegerOpt("TS");
    }

    /**
     * Return true if the annotations for this header contain
     * the reserved key TS, for trace spacing.
     *
     * @since 1.3.2
     * @return true if the annotations for this header contain
     *    the reserved key TS, for trace spacing
     */
    public boolean containsTraceSpacing() {
        return containsTs();
    }

    /**
     * Return the trace spacing for this header (Type=i value for
     * the reserved key TS as an integer).
     *
     * @since 1.3.2
     * @return the trace spacing for this header (Type=i value for
     *    the reserved key TS as an integer)
     */
    public int getTraceSpacing() {
        return getTs();
    }

    /**
     * Return an optional wrapping the trace spacing for this header
     * (Type=i value for the reserved key TS as an integer).
     *
     * @since 1.3.2
     * @return an optional wrapping the trace spacing for this header
     *    (Type=i value for the reserved key TS as an integer)
     */
    public Optional getTraceSpacingOpt() {
        return getTsOpt();
    }

    //

    /**
     * Return true if the annotations for this header contain
     * the reserved key VN.
     *
     * @since 1.3.2
     * @return true if the annotations for this header contain
     *    the reserved key VN
     */
    public boolean containsVn() {
        return containsAnnotationKey("VN");
    }

    /**
     * Return the Type=Z value for the reserved key VN
     * as a string.
     *
     * @since 1.3.2
     * @return the Type=Z value for the reserved key VN
     *    as a string
     */
    public String getVn() {
        return getAnnotationString("VN");
    }

    /**
     * Return an optional Type=Z value for the reserved key VN
     * as a string.
     *
     * @since 1.3.2
     * @return an optional Type=Z value for the reserved key VN
     *   as a string
     */
    public Optional getVnOpt() {
        return getAnnotationStringOpt("Vn");
    }

    /**
     * Return true if the annotations for this header contain
     * the reserved key VN, for version number.
     *
     * @since 1.3.2
     * @return true if the annotations for this header contain
     *    the reserved key VN, for version number
     */
    public boolean containsVersionNumber() {
        return containsVn();
    }

    /**
     * Return the version number for this header (Type=Z value for the
     * reserved key VN as a string).
     *
     * @since 1.3.2
     * @return the version number for this header (Type=Z value for the
     *    reserved key VN as a string)
     */
    public String getVersionNumber() {
        return getVn();
    }

    /**
     * Return an optional wrapping the version number for this header
     * (Type Z value for the reserved key VN as a string).
     *
     * @since 1.3.2
     * @return an optional wrapping the version number for this header
     *    (Type Z value for the reserved key VN as a string)
     */
    public Optional getVersionNumberOpt() {
        return getVnOpt();
    }


    @Override
    public int hashCode() {
        return getAnnotations().hashCode();
    }

    @Override
    public boolean equals(final Object o) {
         if (o == this) {
            return true;
        }
        if (!(o instanceof Header)) {
            return false;
        }
        Header h = (Header) o;

        return getAnnotations().equals(h.getAnnotations());
    }

    @Override
    public String toString() {
        Joiner joiner = Joiner.on("\t");
        StringBuilder sb = new StringBuilder();
        sb.append("H");
        if (!getAnnotations().isEmpty()) {
            sb.append("\t");
            joiner.appendTo(sb, getAnnotations().values());
        }
        return sb.toString();
    }


    /**
     * Parse a header GFA 2.0 record from the specified value.
     *
     * @param value value, must not be null
     * @return a header GFA 2.0 record parsed from the specified value
     */
    public static Header valueOf(final String value) {
        checkNotNull(value);
        checkArgument(value.startsWith("H"), "header value must start with H");
        List tokens = Splitter.on("\t").splitToList(value);
        ImmutableMap.Builder annotations = ImmutableMap.builder();
        for (int i = 1; i < tokens.size(); i++) {
            String token = tokens.get(i);
            if (!token.isEmpty()) {
                Annotation annotation = Annotation.valueOf(token);
                annotations.put(annotation.getName(), annotation);
            }
        }

        return new Header(annotations.build());
    }
}