com.itextpdf.pdfocr.TextInfo Maven / Gradle / Ivy

Go to download
/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2020 iText Group NV
    Authors: iText Software.

    This program is offered under a commercial and under the AGPL license.
    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.

    AGPL licensing:
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see .
 */
package com.itextpdf.pdfocr;

import com.itextpdf.kernel.geom.Rectangle;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;


/**
 * This class describes how recognized text is positioned on the image
 * providing bbox for each text item (could be a line or a word).
 */
public class TextInfo {

    /**
     * Contains any text.
     */
    private String text;

    /**
     * {@link Rectangle} describing text bbox (lower-left based) expressed in points.
     */
    private Rectangle bboxRect;

    /**
     * Contains 4 float coordinates: bbox parameters.
     * Alike bboxRect described by {@link Rectangle}
     * coordinates are upper-left based and expressed in pixels.
     * @deprecated since 1.0.1. Use {@link #bboxRect} instead
     */
    @Deprecated
    private List bbox = Collections.emptyList();

    /**
     * Creates a new {@link TextInfo} instance.
     */
    public TextInfo() {
    }

    /**
     * Creates a new {@link TextInfo} instance from existing one.
     *
     * @param textInfo to create from
     */
    public TextInfo(final TextInfo textInfo) {
        this.text = textInfo.text;
        this.bboxRect = new Rectangle(textInfo.bboxRect);
        this.bbox = Collections.unmodifiableList(textInfo.bbox);
    }

    /**
     * Creates a new {@link TextInfo} instance.
     *
     * @param text any text
     * @param bbox {@link Rectangle} describing text bbox
     */
    public TextInfo(final String text, final Rectangle bbox) {
        this.text = text;
        this.bboxRect = new Rectangle(bbox);
    }

    /**
     * Creates a new {@link TextInfo} instance.
     *
     * @param text any text
     * @param bbox {@link java.util.List} of bbox parameters
     * @deprecated since 1.0.1. Use {@link #TextInfo(String, Rectangle)} instead
     */
    @Deprecated
    public TextInfo(final String text, final List bbox) {
        this.text = text;
        this.bbox = Collections.unmodifiableList(bbox);
    }

    /**
     * Creates a new {@link TextInfo} instance.
     *
     * @param text any text
     * @param bboxRect {@link Rectangle} describing text bbox
     * @param bbox {@link java.util.List} of bbox parameters
     * @deprecated since 1.0.1. Use {@link #TextInfo(String, Rectangle)} instead
     */
    @Deprecated
    public TextInfo(final String text, final Rectangle bboxRect, final List bbox) {
        this.text = text;
        this.bboxRect = bboxRect;
        this.bbox = Collections.unmodifiableList(bbox);
    }

    /**
     * Gets text element.
     *
     * @return String
     */
    public String getText() {
        return text;
    }

    /**
     * Sets text element.
     *
     * @param newText retrieved text
     */
    public void setText(final String newText) {
        text = newText;
    }

    /**
     * Gets bbox coordinates.
     *
     * @return {@link Rectangle} describing text bbox
     */
    public Rectangle getBboxRect() {
        return bboxRect;
    }

    /**
     * Sets text bbox.
     *
     * @param bbox {@link Rectangle} describing text bbox
     */
    public void setBboxRect(final Rectangle bbox) {
        this.bboxRect = new Rectangle(bbox);
        this.bbox = Collections.emptyList();
    }

    /**
     * Gets bbox coordinates.
     *
     * @return {@link java.util.List} of bbox parameters
     * @deprecated since 1.0.1. Use {@link #getBboxRect()} instead
     */
    @Deprecated
    public List getBbox() {
        return new ArrayList(bbox);
    }

    /**
     * Sets bbox coordinates.
     *
     * @param bbox {@link java.util.List} of bbox parameters
     * @deprecated since 1.0.1. Use {@link #setBboxRect(Rectangle)} instead
     */
    @Deprecated
    public void setBbox(final List bbox) {
        this.bbox = Collections.unmodifiableList(bbox);
        this.bboxRect = null;
    }
}