Enum QsRelation

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<QsRelation>

    public enum QsRelation
    extends java.lang.Enum<QsRelation>
    The Quaternary Structure Relation describes the pairwise relation between two quaternary structures.
    Since:
    5.0.0
    Author:
    Aleix Lafita
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DIFFERENT
      None of the Subunits of one Structure have an equivalent in the other Structure.
      EQUIVALENT
      All the Subunits of one Structure have an equivalent in the other Structure.
      PARTIAL_COMPLETE
      All the Subunits of one Structure have an equivalent in the other Structure, but the other Structure contains additional non-matched Subunits.
      PARTIAL_INCOMPLETE
      Only a subset of Subunits of one Structure have an equivalent in the other Structure, and the other Structure also contains additional non-matched Subunits.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static QsRelation valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static QsRelation[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • EQUIVALENT

        public static final QsRelation EQUIVALENT
        All the Subunits of one Structure have an equivalent in the other Structure.

        An example of this relation is comparing an A2B2 complex with C2 symmetry against a similar A2B2 complex with the same C2 symmetry axis (same topology).

      • PARTIAL_COMPLETE

        public static final QsRelation PARTIAL_COMPLETE
        All the Subunits of one Structure have an equivalent in the other Structure, but the other Structure contains additional non-matched Subunits.

        An example of this relation is comparing an A2B2 complex with C2 symmetry against a similar A2 complex with the same C2 symmetry axis. Another example is comparing an A4 complex with D2 symmetry against an A2 complex with the same C2 symmetry axis as one of the D2 axes.

      • PARTIAL_INCOMPLETE

        public static final QsRelation PARTIAL_INCOMPLETE
        Only a subset of Subunits of one Structure have an equivalent in the other Structure, and the other Structure also contains additional non-matched Subunits.

        An example of this relation is comparing an A2B2 complex with C2 symmetry against an A2C2 complex, where As are similar but B and C differ, with the same C2 symmetry axis. Only the A2 part of the structure matches.

    • Method Detail

      • values

        public static QsRelation[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (QsRelation c : QsRelation.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static QsRelation valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null