Enum Class CorrelationCaseDescription.Match

All Implemented Interfaces:
Serializable, Comparable<CorrelationCaseDescription.Match>, Constable
Enclosing class:
CorrelationCaseDescription<F extends FocusType>

public static enum CorrelationCaseDescription.Match extends Enum<CorrelationCaseDescription.Match>
How well the candidate matches the object being correlated on given correlation property?
  • Enum Constant Details

    • FULL

      public static final CorrelationCaseDescription.Match FULL
      A full match: The default normalization of the primary value (or one of the primary values) exactly matches the same normalization of the source value. Usually displayed in green. (Default normalization is either default "indexing", or the result of the application of the item matching rule from the object template.) This should be adequate for the majority of cases. An exception could be if we use a correlator with more strict indexing than the default one. But this may be seen as a configuration issue: one should perhaps set the default correlator to be the more strict one.

      public static final CorrelationCaseDescription.Match PARTIAL
      A partial match. The "baseline" meaning is that any normalization of any primary or secondary value exactly matches the same normalization of the source value. For items mentioned by "items" correlator(s) the partial match is also if at least one filter defined in the correlator matches. This may include fuzzy search filters, e.g., Levenshtein edit distance or trigram similarity. Usually displayed in orange.
    • NONE

      public static final CorrelationCaseDescription.Match NONE
      No match. The values are present, and should match. However, neither FULL nor PARTIAL case applies. Usually displayed in red.

      public static final CorrelationCaseDescription.Match NOT_APPLICABLE
      The matching is not applicable, for example because the correlation property has no value in object being correlated.
  • Method Details

    • values

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

      public static CorrelationCaseDescription.Match 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.)
      name - the name of the enum constant to be returned.
      the enum constant with the specified name
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null