Package ca.uhn.fhir.mdm.api

Class MdmMatchOutcome

java.lang.Object

ca.uhn.fhir.mdm.api.MdmMatchOutcome

public final class MdmMatchOutcome
extends Object

This data object captures the final outcome of an MDM match

Field Summary

Fields

Modifier and Type	Field	Description
static final MdmMatchOutcome	EID_MATCH
static final MdmMatchOutcome	NEW_GOLDEN_RESOURCE_MATCH
static final MdmMatchOutcome	NO_MATCH
static final MdmMatchOutcome	POSSIBLE_DUPLICATE
static final MdmMatchOutcome	POSSIBLE_MATCH

Constructor Summary

Constructors

Constructor	Description
MdmMatchOutcome(Long theVector, Double theScore)

Method Summary

Modifier and Type	Method	Description
MdmMatchResultEnum	getMatchResultEnum()
int	getMdmRuleCount()	Gets the number of MDM rules checked for this match outcome
Double	getNormalizedScore()	Gets normalized score that is in the range from zero to one
Double	getScore()
Long	getVector()
boolean	isCreatedNewResource()
boolean	isEidMatch()
boolean	isMatch()
boolean	isPossibleDuplicate()
boolean	isPossibleMatch()
MdmMatchOutcome	setCreatedNewResource(boolean theCreatedNewResource)
MdmMatchOutcome	setEidMatch(boolean theEidMatch)
MdmMatchOutcome	setMatchResultEnum(MdmMatchResultEnum theMatchResultEnum)
MdmMatchOutcome	setMdmRuleCount(int theMdmRuleCount)	Sets the number of MDM rules checked for this match outcome
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

POSSIBLE_DUPLICATE

public static final MdmMatchOutcome POSSIBLE_DUPLICATE

NO_MATCH

public static final MdmMatchOutcome NO_MATCH

NEW_GOLDEN_RESOURCE_MATCH

public static final MdmMatchOutcome NEW_GOLDEN_RESOURCE_MATCH

EID_MATCH

public static final MdmMatchOutcome EID_MATCH

POSSIBLE_MATCH

public static final MdmMatchOutcome POSSIBLE_MATCH

Constructor Details

MdmMatchOutcome

public MdmMatchOutcome(Long theVector,
 Double theScore)

Method Details

isMatch

public boolean isMatch()

isPossibleMatch

public boolean isPossibleMatch()

isPossibleDuplicate

public boolean isPossibleDuplicate()

getMatchResultEnum

public MdmMatchResultEnum getMatchResultEnum()

setMatchResultEnum

public MdmMatchOutcome setMatchResultEnum(MdmMatchResultEnum theMatchResultEnum)

isCreatedNewResource

public boolean isCreatedNewResource()

setCreatedNewResource

public MdmMatchOutcome setCreatedNewResource(boolean theCreatedNewResource)

Parameters:

theCreatedNewResource - this match is creating a new golden resource

isEidMatch

public boolean isEidMatch()

setMdmRuleCount

public MdmMatchOutcome setMdmRuleCount(int theMdmRuleCount)

Sets the number of MDM rules checked for this match outcome

Parameters:

theMdmRuleCount - Number of MDM rules that were checked for this match outcome

Returns:

Returns this instance

getMdmRuleCount

public int getMdmRuleCount()

Gets the number of MDM rules checked for this match outcome

Returns:

Returns the number of rules

setEidMatch

public MdmMatchOutcome setEidMatch(boolean theEidMatch)

Parameters:

theEidMatch - the link was established via a shared EID

getScore

public Double getScore()

getVector

public Long getVector()

getNormalizedScore

public Double getNormalizedScore()

Gets normalized score that is in the range from zero to one

Returns:

Returns the normalized score

toString

public String toString()

Overrides:

toString in class Object