com.formkiq.vision.comparator.DocumentBlockUpperYXComparator Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2018 FormKiQ Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.formkiq.vision.comparator;

import static java.lang.Math.abs;

import java.io.Serializable;
import java.util.Comparator;

import com.formkiq.vision.document.DocumentBlockRectangle;

/**
 * {@link DocumentBlockRectangle} {@link Comparator} for Y position then X position.
 *
 */
public class DocumentBlockUpperYXComparator
        implements Comparator, Serializable {

    /** serialVersionUID. */
    private static final long serialVersionUID = 5017459634232423133L;

    /** delta. */
    private int delta = 0;

    /**
     * constructor.
     */
    public DocumentBlockUpperYXComparator() {
        this(0);
    }

    /**
     * constructor.
     * @param deltaInt int
     */
    public DocumentBlockUpperYXComparator(final int deltaInt) {

        this.delta = deltaInt;

        final int maxdelta = 5;
        if (this.delta > maxdelta) {
            throw new IllegalArgumentException("Delta must be less than 5");
        }
    }

    @Override
    public int compare(final DocumentBlockRectangle r1,
            final DocumentBlockRectangle r2) {
        int lowerY2 = Math.round(r2.getUpperRightY());
        int lowerY1 = Math.round(r1.getUpperRightY());
        int result = Integer.compare(lowerY2, lowerY1);

        if (abs(lowerY2 - lowerY1) < this.delta) {
            result = 0;
        }

        if (result == 0) {
            result = Float.compare(r1.getLowerLeftX(), r2.getLowerLeftX());
        }

        return result;
    }
}