Package com.evolveum.midpoint.model.api.correlator

Class CorrelationExplanation

java.lang.Object

com.evolveum.midpoint.model.api.correlator.CorrelationExplanation

All Implemented Interfaces:

DebugDumpable, Serializable

Direct Known Subclasses:

CompositeCorrelationExplanation, CorrelationExplanation.GenericCorrelationExplanation, CorrelationExplanation.UnsupportedCorrelationExplanation, ItemsCorrelationExplanation

public abstract class CorrelationExplanation
extends Object
implements Serializable, DebugDumpable

Describes how the correlator (could) came to a given candidate owner, and the specific confidence value of it. There are subtypes of this class for particular correlators, with the special cases for generic and unsupported correlators.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CorrelationExplanation.GenericCorrelationExplanation	This is for correlators that support candidate check (i.e., determining confidence for the provided candidate) but do not provide any the specific explanations of their decisions.
static class	CorrelationExplanation.UnsupportedCorrelationExplanation	This is for correlators that do not support neither explanation nor candidate check (i.e., determining confidence for the provided candidate).

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NotNull Confidence	confidence	The resulting confidence computed by the correlator.

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
String	debugDump(int indent)
@NotNull Confidence	getConfidence()
abstract @NotNull LocalizableMessage	toLocalizableMessage()	Returns the explanation formatted as a text.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable

debugDump, debugDumpLazily, debugDumpLazily

Field Details

confidence

@NotNull
protected final @NotNull Confidence confidence

The resulting confidence computed by the correlator.

Method Details

toLocalizableMessage

@NotNull
public abstract @NotNull LocalizableMessage toLocalizableMessage()

Returns the explanation formatted as a text.

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

toString

public String toString()

Overrides:

toString in class Object

getConfidence

@NotNull
public @NotNull Confidence getConfidence()