Enum Class PairMode

java.lang.Object
java.lang.Enum<PairMode>
uk.ac.starlink.table.join.PairMode
All Implemented Interfaces:
Serializable, Comparable<PairMode>, Constable

public enum PairMode extends Enum<PairMode>
Enumeration used to determine which row links result from a pair match operation.
See Also:
  • Enum Constant Details

    • ALL

      public static final PairMode ALL
      All matches are returned.
    • BEST

      public static final PairMode BEST
      Only the best matches are returned, obtained symmetrically. Each row from both input tables will appear in at most one RowLink in the result.
    • BEST1

      public static final PairMode BEST1
      For each row in table 1, only the best match in table 2 is returned. Each row from table 1 will appear a maximum of once in the result, but rows from table 2 may appear multiple times.
    • BEST2

      public static final PairMode BEST2
      For each row in table 2, only the best match in table 1 is returned. Each row from table 2 will appear a maximum of once in the result, but rows from table 1 may appear multiple times.
  • Method Details

    • values

      public static PairMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static PairMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • mayProduceGroups

      public boolean mayProduceGroups()
      Indicates whether the result of a match performed in this mode may contain non-trivial related groups of rows. A group represents a match in which an object in one table corresponds to more than object in the other table.
      Returns:
      true iff this mode may result in ambiguous matches
      See Also:
    • getSummary

      public String getSummary()
      Returns a short summary of the matching policy.
      Returns:
      short description string