Package ca.uhn.fhir.mdm.rules.matcher

Enum MdmMatcherEnum

java.lang.Object

java.lang.Enum<MdmMatcherEnum>

ca.uhn.fhir.mdm.rules.matcher.MdmMatcherEnum

All Implemented Interfaces:

Serializable, Comparable<MdmMatcherEnum>

public enum MdmMatcherEnum
extends Enum<MdmMatcherEnum>

Enum for holding all the known FHIR Element matchers that we support in HAPI. The string matchers first encode the string using an Apache Encoder before comparing them. https://commons.apache.org/proper/commons-codec/userguide.html

Enum Constant Summary

Enum Constants

Enum Constant	Description
CAVERPHONE1
CAVERPHONE2
COLOGNE
DATE
DOUBLE_METAPHONE
EMPTY_FIELD
EXTENSION_ANY_ORDER
IDENTIFIER
MATCH_RATING_APPROACH
METAPHONE
NAME_ANY_ORDER
NAME_FIRST_AND_LAST
NUMERIC
NYSIIS
REFINED_SOUNDEX
SOUNDEX
STRING
SUBSTRING

Method Summary

Modifier and Type	Method	Description
boolean	isMatchingEmptyFields()	Checks if this matcher supports checks on empty fields
boolean	match(ca.uhn.fhir.context.FhirContext theFhirContext, org.hl7.fhir.instance.model.api.IBase theLeftBase, org.hl7.fhir.instance.model.api.IBase theRightBase, boolean theExact, String theIdentifierSystem)	Determines whether two FHIR elements match according using the provided IMdmFieldMatcher
static MdmMatcherEnum	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MdmMatcherEnum[]	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

CAVERPHONE1

public static final MdmMatcherEnum CAVERPHONE1

CAVERPHONE2

public static final MdmMatcherEnum CAVERPHONE2

COLOGNE

public static final MdmMatcherEnum COLOGNE

DOUBLE_METAPHONE

public static final MdmMatcherEnum DOUBLE_METAPHONE

MATCH_RATING_APPROACH

public static final MdmMatcherEnum MATCH_RATING_APPROACH

METAPHONE

public static final MdmMatcherEnum METAPHONE

NYSIIS

public static final MdmMatcherEnum NYSIIS

REFINED_SOUNDEX

public static final MdmMatcherEnum REFINED_SOUNDEX

SOUNDEX

public static final MdmMatcherEnum SOUNDEX

STRING

public static final MdmMatcherEnum STRING

SUBSTRING

public static final MdmMatcherEnum SUBSTRING

DATE

public static final MdmMatcherEnum DATE

NAME_ANY_ORDER

public static final MdmMatcherEnum NAME_ANY_ORDER

NAME_FIRST_AND_LAST

public static final MdmMatcherEnum NAME_FIRST_AND_LAST

IDENTIFIER

public static final MdmMatcherEnum IDENTIFIER

EMPTY_FIELD

public static final MdmMatcherEnum EMPTY_FIELD

EXTENSION_ANY_ORDER

public static final MdmMatcherEnum EXTENSION_ANY_ORDER

NUMERIC

public static final MdmMatcherEnum NUMERIC

Method Detail

values

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

Returns:

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

valueOf

public static MdmMatcherEnum 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

match

public boolean match(ca.uhn.fhir.context.FhirContext theFhirContext,
                     org.hl7.fhir.instance.model.api.IBase theLeftBase,
                     org.hl7.fhir.instance.model.api.IBase theRightBase,
                     boolean theExact,
                     String theIdentifierSystem)

Determines whether two FHIR elements match according using the provided IMdmFieldMatcher

Parameters:

theFhirContext -

theLeftBase - left FHIR element to compare

theRightBase - right FHIR element to compare

theExact - used by String matchers. If "false" then the string is normalized (case, accents) before comparing. If "true" then an exact string comparison is performed.

theIdentifierSystem - used optionally by the IDENTIFIER matcher, when present, only matches the identifiers if they belong to this system.

Returns:

isMatchingEmptyFields

public boolean isMatchingEmptyFields()

Checks if this matcher supports checks on empty fields

Returns:

Returns true of this matcher supports empty fields and false otherwise