001/*
002 *                    BioJava development code
003 *
004 * This code may be freely distributed and modified under the
005 * terms of the GNU Lesser General Public Licence.  This should
006 * be distributed with the code.  If you do not have a copy,
007 * see:
008 *
009 *      http://www.gnu.org/copyleft/lesser.html
010 *
011 * Copyright for this code is held jointly by the individual
012 * authors.  These should be listed in @author doc comments.
013 *
014 * For more information on the BioJava project and its aims,
015 * or to join the biojava-l mailing list, visit the home page
016 * at:
017 *
018 *      http://www.biojava.org/
019 *
020 */
021package org.biojava.nbio.core.sequence;
022
023
024/**
025 * Provides a way of representing the strand of a sequence, location
026 * hit or feature.
027 *
028 * @author ayates
029 */
030public enum Strand {
031
032        POSITIVE("+", 1), NEGATIVE("-", -1), UNDEFINED(".", 0);
033        private final String stringRepresentation;
034        private final int numericRepresentation;
035
036        private Strand(String stringRepresentation, int numericRepresentation) {
037                this.stringRepresentation = stringRepresentation;
038                this.numericRepresentation = numericRepresentation;
039        }
040
041        public int getNumericRepresentation() {
042                return numericRepresentation;
043        }
044
045        public String getStringRepresentation() {
046                return stringRepresentation;
047        }
048
049        public Strand getReverse() {
050                switch (this) {
051                        case POSITIVE:
052                                return NEGATIVE;
053                        case NEGATIVE:
054                                return POSITIVE;
055                        default:
056                                return UNDEFINED;
057                }
058        }
059}