/*
 *                    BioJava development code
 *
 * This code may be freely distributed and modified under the
 * terms of the GNU Lesser General Public Licence.  This should
 * be distributed with the code.  If you do not have a copy,
 * see:
 *
 *      http://www.gnu.org/copyleft/lesser.html
 *
 * Copyright for this code is held jointly by the individual
 * authors.  These should be listed in @author doc comments.
 *
 * @author Karl Nicholas <github:karlnicholas>
 * 
 * For more information on the BioJava project and its aims,
 * or to join the biojava-l mailing list, visit the home page
 * at:
 *
 *      http://www.biojava.org/
 *
 * Created on 01-21-2010
 */
package org.biojava3.core.sequence.io;

import java.util.ArrayList;

import org.biojava3.core.exceptions.ParserException;
import org.biojava3.core.sequence.AccessionID;
import org.biojava3.core.sequence.io.template.SequenceHeaderParserInterface;
import org.biojava3.core.sequence.template.AbstractSequence;
import org.biojava3.core.sequence.template.Compound;

public class GenericGenbankHeaderParser<S extends AbstractSequence<C>, C extends Compound> implements SequenceHeaderParserInterface<S,C> {

	private String accession = null;
	private String identifier = null;
	private String name = null;
    @SuppressWarnings("unused")
	private int version;
    private boolean versionSeen;
    private ArrayList<String> comments = new ArrayList<String>();

    /**
     * Parse the header and set the values in the sequence
     * @param header
     * @param sequence
     */
    public void parseHeader(String header, S sequence) {
    	sequence.setOriginalHeader(header);
    	sequence.setAccession(new AccessionID(accession));
    	sequence.setDescription(description);
    }
    
    /**
     * Sets the sequence info back to default values, ie. in order to start
     * constructing a new sequence from scratch.
     */
    @SuppressWarnings("unused")
	private void reset() {
        this.version = 0;
        this.versionSeen = false;
        this.accession = null;
        this.description = null;
        this.identifier = null;
        this.name = null;
        this.comments.clear();
    }
    
    /**
     * {@inheritDoc}
     */
    public void setVersion(int version) throws ParserException {
        if (this.versionSeen) throw new ParserException("Current BioEntry already has a version");
        else {
            try {
                this.version = version;
                this.versionSeen = true;
            } catch (NumberFormatException e) {
                throw new ParserException("Could not parse version as an integer");
            }
        }
    }
    
    
    /**
     * {@inheritDoc}
     * The last accession passed to this routine will always be the one used.
     */
    public void setAccession(String accession) throws ParserException {
        if (accession==null) throw new ParserException("Accession cannot be null");
        this.accession = accession;
    }
    
    /**
     * {@inheritDoc}
     */
    public void setDescription(String description) throws ParserException {
        if (this.description!=null) throw new ParserException("Current BioEntry already has a description");
        this.description = description;
    }
    private String description;
    
    /**
     * {@inheritDoc}
     */
    public void setIdentifier(String identifier) throws ParserException {
        if (identifier==null) throw new ParserException("Identifier cannot be null");
        if (this.identifier!=null) throw new ParserException("Current BioEntry already has a identifier");
        this.identifier = identifier;
    }
    
    /**
     * {@inheritDoc}
     */
    public void setName(String name) throws ParserException {
        if (name==null) throw new ParserException("Name cannot be null");
        if (this.name!=null) throw new ParserException("Current BioEntry already has a name");
        this.name = name;
    }
    
    /**
     * {@inheritDoc}
     */
    public void setComment(String comment) throws ParserException {
        if (comment==null) throw new ParserException("Comment cannot be null");
        this.comments.add(comment);
    }
}
