001/*-
002 * #%L
003 * HAPI FHIR - Master Data Management
004 * %%
005 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 *
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package ca.uhn.fhir.mdm.rules.matcher.models;
021
022import ca.uhn.fhir.mdm.rules.json.MdmMatcherJson;
023import org.hl7.fhir.instance.model.api.IBase;
024
025/**
026 * Measure how similar two IBase (resource fields) are to one another.  1.0 means identical.  0.0 means completely different.
027 */
028public interface IMdmFieldMatcher {
029        /**
030         * Checks if theLeftBase and theRightBase match, returning true if they do
031         * and false otherwise.
032         */
033        boolean matches(IBase theLeftBase, IBase theRightBase, MdmMatcherJson theParams);
034
035        /**
036         * True if matcher can/will match empty (null) fields,
037         * false otherwise.
038         */
039        default boolean isMatchingEmptyFields() {
040                // false because most people are overriding this
041                return false;
042        }
043}