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.structure.align.quaternary;
022
023/**
024 * The Quaternary Structure Relation describes the pairwise relation between two
025 * quaternary structures.
026 *
027 * @author Aleix Lafita
028 * @since 5.0.0
029 *
030 */
031public enum QsRelation {
032
033        /**
034         * All the Subunits of one Structure have an equivalent in the other
035         * Structure.
036         * <p>
037         * An example of this relation is comparing an A2B2 complex with C2 symmetry
038         * against a similar A2B2 complex with the same C2 symmetry axis (same
039         * topology).
040         **/
041        EQUIVALENT,
042
043        /**
044         * All the Subunits of one Structure have an equivalent in the other
045         * Structure, but the other Structure contains additional non-matched
046         * Subunits.
047         * <p>
048         * An example of this relation is comparing an A2B2 complex with C2 symmetry
049         * against a similar A2 complex with the same C2 symmetry axis. Another
050         * example is comparing an A4 complex with D2 symmetry against an A2 complex
051         * with the same C2 symmetry axis as one of the D2 axes.
052         */
053        PARTIAL_COMPLETE,
054
055        /**
056         * Only a subset of Subunits of one Structure have an equivalent in the
057         * other Structure, and the other Structure also contains additional
058         * non-matched Subunits.
059         * <p>
060         * An example of this relation is comparing an A2B2 complex with C2 symmetry
061         * against an A2C2 complex, where As are similar but B and C differ, with
062         * the same C2 symmetry axis. Only the A2 part of the structure matches.
063         */
064        PARTIAL_INCOMPLETE,
065
066        /**
067         * None of the Subunits of one Structure have an equivalent in the other
068         * Structure.
069         * <p>
070         * Two quaternary structures are different if they are not
071         * {@link #EQUIVALENT}, {@link #PARTIAL_COMPLETE} or
072         * {@link #PARTIAL_INCOMPLETE}.
073         */
074        DIFFERENT;
075}