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

Class CorrelationCaseDescription<F extends FocusType>

java.lang.Object

com.evolveum.midpoint.model.api.correlation.CorrelationCaseDescription<F>

All Implemented Interfaces:

DebugDumpable, Serializable

public class CorrelationCaseDescription<F extends FocusType>
extends Object
implements DebugDumpable, Serializable

Describes a correlation case, typically when it's going to be presented to the user. Need not be connected to actual CaseType object. The term "case" is used more figuratively here, to describe a correlation situation that is going to be resolved. Contains the object being correlated (currently called preFocus) and the correlation candidates (candidates). The correlation data are represented as a set of correlationPropertiesDefinitions, whose values on the source are to be fetched directly from preFocus, but the valued for candidates are processed into the form of CorrelationCaseDescription.CorrelationPropertyValuesDescription: - sorted out into "primary" and "secondary" values (corresponding to the main identity and alternative ones), - and providing a CorrelationCaseDescription.Match value that shows the degree of match between the particular candidate and the pre-focus on this particular property. Optionally, there may be a CorrelationExplanation object for each correlation candidate. (If requested.)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CorrelationCaseDescription.CandidateDescription<F extends FocusType>
static class	CorrelationCaseDescription.CorrelationPropertyValuesDescription
static enum	CorrelationCaseDescription.Match	How well the candidate matches the object being correlated on given correlation property?

Field Summary

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
CorrelationCaseDescription(F preFocus)

Method Summary

Modifier and Type	Method	Description
void	addCandidate(CorrelationCaseDescription.CandidateDescription<F> description)
void	addCorrelationPropertyDefinition(CorrelationPropertyDefinition property)
String	debugDump(int indent)
@NotNull List<CorrelationCaseDescription.CandidateDescription<F>>	getCandidates()
@NotNull PathKeyedMap<CorrelationPropertyDefinition>	getCorrelationPropertiesDefinitions()
@NotNull List<CorrelationPropertyDefinition>	getCorrelationPropertiesDefinitionsList()	The list is sorted according to display order (and display name, in case of ambiguity).
F	getPreFocus()
boolean	hasCorrelationProperty(@NotNull ItemPath path)
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

Constructor Details

CorrelationCaseDescription

public CorrelationCaseDescription(@NotNull
 F preFocus)

Method Details

getPreFocus

@NotNull
public F getPreFocus()

getCorrelationPropertiesDefinitions

@NotNull
public @NotNull PathKeyedMap<CorrelationPropertyDefinition> getCorrelationPropertiesDefinitions()

getCorrelationPropertiesDefinitionsList

@NotNull
public @NotNull List<CorrelationPropertyDefinition> getCorrelationPropertiesDefinitionsList()

The list is sorted according to display order (and display name, in case of ambiguity).

getCandidates

@NotNull
public @NotNull List<CorrelationCaseDescription.CandidateDescription<F>> getCandidates()

hasCorrelationProperty

public boolean hasCorrelationProperty(@NotNull
 @NotNull ItemPath path)

addCorrelationPropertyDefinition

public void addCorrelationPropertyDefinition(CorrelationPropertyDefinition property)

toString

public String toString()

Overrides:

toString in class Object

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

addCandidate

public void addCandidate(CorrelationCaseDescription.CandidateDescription<F> description)