Package com.evolveum.midpoint.model.api.correlation

Enum CorrelationCaseDescription.Match

java.lang.Object

java.lang.Enum<CorrelationCaseDescription.Match>

com.evolveum.midpoint.model.api.correlation.CorrelationCaseDescription.Match

All Implemented Interfaces:

Serializable, Comparable<CorrelationCaseDescription.Match>

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 Summary

Enum Constants

Enum Constant	Description
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.
NONE	No match.
NOT_APPLICABLE	The matching is not applicable, for example because the correlation property has no value in object being correlated.
PARTIAL	A partial match.

Method Summary

Modifier and Type	Method	Description
static CorrelationCaseDescription.Match	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CorrelationCaseDescription.Match[]	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

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.

PARTIAL

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.

NOT_APPLICABLE

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 Detail

values

public static CorrelationCaseDescription.Match[] 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 (CorrelationCaseDescription.Match c : CorrelationCaseDescription.Match.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CorrelationCaseDescription.Match valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null