de.ipk_gatersleben.bit.bi.isa4j.components.OntologyAnnotation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of isa4j Show documentation
Fast and Scalable Java Library for Writing ISA-Tab Files
The newest version!
/**
 * Copyright (c) 2021 Leibniz Institute of Plant Genetics and Crop Plant Research (IPK), Gatersleben, Germany.
 * All rights reserved. This program and the accompanying materials are made available under the terms of the MIT License (https://spdx.org/licenses/MIT.html)
 *
 * Contributors:
 *      Leibniz Institute of Plant Genetics and Crop Plant Research (IPK), Gatersleben, Germany
 */
package de.ipk_gatersleben.bit.bi.isa4j.components;

import java.util.Objects;

import de.ipk_gatersleben.bit.bi.isa4j.util.StringUtil;

/**
 * Class representing a {@link Ontology} based term. Every {@link OntologyAnnotation} has
 * three Attributes: Name, AccessionNumber and SourceREF
 *
 * @author liufe, arendd
 */
public class OntologyAnnotation implements Commentable {
	
	private CommentCollection comments = new CommentCollection();
	
	/**
     * sourceREF of ontology term
     */
    private Ontology sourceREF;

    /**
     * term of Ontology term
     */
    private String term;

    /**
     * accession number of ontology term
     */
    private String termAccession;

    public OntologyAnnotation(String term) {
    	this(term,  null, null);
    }
    
    public OntologyAnnotation(String term, String termAccessionNumber, Ontology sourceREF) {
    	this.term = term;
    	this.termAccession = termAccessionNumber;
    	this.sourceREF = sourceREF;
    }
    
    public CommentCollection comments() {
		return this.comments;
	}
   

    /**
     * get sourceREF
     *
     * @return sourceREF
     */
    public Ontology getSourceREF() {
        return sourceREF;
    }

    /**
     * get term of ontology term
     *
     * @return term of ontology term
     */
    public String getTerm() {
        return term;
    }

    /**
     * get accession number of ontology term
     *
     * @return accession number of ontology term
     */
    public String getTermAccession() {
        return termAccession;
    }

    /**
     * set source REF
     *
     * @param sourceREF source REF
     */
    public void setSourceREF(Ontology sourceREF) {
        this.sourceREF = sourceREF;
    }

    /**
     * set term of ontology term
     *
     * @param term term of ontology term
     */
    public void setTerm(String term) {
        this.term = StringUtil.sanitize(Objects.requireNonNull(term));
    }

    /**
     * set accession number of ontology term
     *
     * @param termAccession accession number of ontology term
     */
    public void setTermAccession(String termAccession) {
        this.termAccession = StringUtil.sanitize(termAccession);
    }
    
	@Override
	public String toString() {
		return " '" + this.term + "'" + (this.sourceREF == null ? "" : " (" + this.sourceREF + ")");
	}

}