com.bakdata.dedupe.similarity.TransformingSimilarityMeasure Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation

Base interfaces and data structures for defining a deduplication workflow.

The newest version!

/*
 * MIT License
 *
 * Copyright (c) 2019 bakdata GmbH
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.bakdata.dedupe.similarity;

import lombok.NonNull;
import lombok.Value;


/**
 * Applies a {@link SimilarityMeasure} to transformed input values. In particular, the same {@link ValueTransformation}
 * is applied to the left and right input.
 *
 * @param  the type of the transformed values.
 * @param  the record type.
 */
@Value
public class TransformingSimilarityMeasure implements SimilarityMeasure {
    /**
     * The transformation that is applied to both inputs before calculating the similarity.
     */
    @NonNull ValueTransformation transformation;
    /**
     * The similarity measure to apply on the transformed values.
     */
    @NonNull SimilarityMeasure measure;

    @Override
    public double getNonNullSimilarity(final @NonNull T left, final @NonNull T right,
            final @NonNull SimilarityContext context) {
        return context.safeExecute(() -> {
            R leftElement = this.transformation.transform(left, context);
            R rightElement = this.transformation.transform(right, context);
            return this.measure.getSimilarity(leftElement, rightElement, context);
        }).orElse(context.getSimilarityForNull(left, right, context));
    }

    @Override
    public @NonNull SimilarityMeasure cutoff(final double threshold) {
        return new TransformingSimilarityMeasure<>(this.transformation, this.measure.cutoff(threshold));
    }
}