Package uk.ac.starlink.table.join
Enum Class PairMode
- All Implemented Interfaces:
Serializable
,Comparable<PairMode>
,Constable
Enumeration used to determine which row links result from a pair
match operation.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionReturns a short summary of the matching policy.boolean
Indicates whether the result of a match performed in this mode may contain non-trivial related groups of rows.static PairMode
Returns the enum constant of this class with the specified name.static PairMode[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
ALL
All matches are returned. -
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
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
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
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
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 nameNullPointerException
- 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
Returns a short summary of the matching policy.- Returns:
- short description string
-