Added input related exceptions in pdfOcr

DEVSIX-5742

Author: dmitry.radchuk

pdfocr-api/src/main/java/com/itextpdf/pdfocr/OcrPdfCreator.java

@@ -57,7 +57,8 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.font.FontProvider;
 import com.itextpdf.layout.properties.TextAlignment;
 import com.itextpdf.pdfa.PdfADocument;
-import com.itextpdf.pdfocr.exceptions.OcrException;
+import com.itextpdf.pdfocr.exceptions.PdfOcrException;
+import com.itextpdf.pdfocr.exceptions.PdfOcrExceptionMessageConstant;
 import com.itextpdf.pdfocr.logs.PdfOcrLogMessageConstant;
 import com.itextpdf.pdfocr.statistics.PdfOcrOutputType;
 import com.itextpdf.pdfocr.statistics.PdfOcrOutputTypeStatisticsEvent;
@@ -165,14 +166,14 @@ public final void setOcrPdfCreatorProperties(
      * @return result PDF/A-3u {@link com.itextpdf.kernel.pdf.PdfDocument}
      * object
      *
-     * @throws OcrException if it was not possible to read provided or
+     * @throws PdfOcrException if it was not possible to read provided or
      *                      default font
      */
     public final PdfDocument createPdfA(final List<File> inputImages,
             final PdfWriter pdfWriter,
             final DocumentProperties documentProperties,
             final PdfOutputIntent pdfOutputIntent)
-            throws OcrException {
+            throws PdfOcrException {
         LOGGER.info(MessageFormatUtil.format(
                 PdfOcrLogMessageConstant.START_OCR_FOR_IMAGES,
                 inputImages.size()));
@@ -220,13 +221,13 @@ public final PdfDocument createPdfA(final List<File> inputImages,
      * @return result PDF/A-3u {@link com.itextpdf.kernel.pdf.PdfDocument}
      * object
      *
-     * @throws OcrException if it was not possible to read provided or
+     * @throws PdfOcrException if it was not possible to read provided or
      *                      default font
      */
     public final PdfDocument createPdfA(final List<File> inputImages,
             final PdfWriter pdfWriter,
             final PdfOutputIntent pdfOutputIntent)
-            throws OcrException {
+            throws PdfOcrException {
         return createPdfA(inputImages, pdfWriter, new DocumentProperties(), pdfOutputIntent);
     }
 
@@ -247,12 +248,12 @@ public final PdfDocument createPdfA(final List<File> inputImages,
      *
      * @return result {@link com.itextpdf.kernel.pdf.PdfDocument} object
      *
-     * @throws OcrException if provided font is incorrect
+     * @throws PdfOcrException if provided font is incorrect
      */
     public final PdfDocument createPdf(final List<File> inputImages,
             final PdfWriter pdfWriter,
             final DocumentProperties documentProperties)
-            throws OcrException {
+            throws PdfOcrException {
         return createPdfA(inputImages, pdfWriter, documentProperties, null);
     }
 
@@ -272,11 +273,11 @@ public final PdfDocument createPdf(final List<File> inputImages,
      *
      * @return result {@link com.itextpdf.kernel.pdf.PdfDocument} object
      *
-     * @throws OcrException if provided font is incorrect
+     * @throws PdfOcrException if provided font is incorrect
      */
     public final PdfDocument createPdf(final List<File> inputImages,
             final PdfWriter pdfWriter)
-            throws OcrException {
+            throws PdfOcrException {
         return createPdfA(inputImages, pdfWriter, new DocumentProperties(), null);
     }
 
@@ -288,12 +289,12 @@ public final PdfDocument createPdf(final List<File> inputImages,
      * @param outPdfFile  the {@link java.io.File} object to write final PDF document to
      *
      * @throws IOException  signals that an I/O exception of some sort has occurred.
-     * @throws OcrException if it was not possible to read provided or
+     * @throws PdfOcrException if it was not possible to read provided or
      *                      default font
      */
     public void createPdfFile(final List<File> inputImages,
             final File outPdfFile)
-            throws OcrException, IOException {
+            throws PdfOcrException, IOException {
         createPdfAFile(inputImages, outPdfFile, null);
     }
 
@@ -308,13 +309,13 @@ public void createPdfFile(final List<File> inputImages,
      *                        for PDF/A-3u document
      *
      * @throws IOException  signals that an I/O exception of some sort has occurred
-     * @throws OcrException if it was not possible to read provided or
+     * @throws PdfOcrException if it was not possible to read provided or
      *                      default font
      */
     public void createPdfAFile(final List<File> inputImages,
             final File outPdfFile,
             final PdfOutputIntent pdfOutputIntent)
-            throws OcrException, IOException {
+            throws PdfOcrException, IOException {
         DocumentProperties documentProperties = new DocumentProperties();
         if (ocrPdfCreatorProperties.getMetaInfo() != null) {
             documentProperties.setEventCountingMetaInfo(ocrPdfCreatorProperties.getMetaInfo());
@@ -356,13 +357,13 @@ public final void setOcrEngine(final IOcrEngine reader) {
      * @param imageData input image if it is a single page or its one page if
      *                 this is a multi-page image
      * @param createPdfA3u true if PDF/A3u document is being created
-     * @throws OcrException if PDF/A3u document is being created and provided
+     * @throws PdfOcrException if PDF/A3u document is being created and provided
      * font contains notdef glyphs
      */
     private void addToCanvas(final PdfDocument pdfDocument,
             final Rectangle imageSize,
             final List<TextInfo> pageText, final ImageData imageData,
-            final boolean createPdfA3u) throws OcrException {
+            final boolean createPdfA3u) throws PdfOcrException {
         final Rectangle rectangleSize =
                 ocrPdfCreatorProperties.getPageSize() == null
                         ? imageSize : ocrPdfCreatorProperties.getPageSize();
@@ -393,11 +394,11 @@ private void addToCanvas(final PdfDocument pdfDocument,
         try {
             addTextToCanvas(imageSize, pageText, canvas, multiplier,
                     pdfPage.getMediaBox());
-        } catch (OcrException e) {
+        } catch (PdfOcrException e) {
             LOGGER.error(MessageFormatUtil.format(
-                    OcrException.CANNOT_CREATE_PDF_DOCUMENT,
+                    PdfOcrExceptionMessageConstant.CANNOT_CREATE_PDF_DOCUMENT,
                     e.getMessage()));
-            throw new OcrException(OcrException.CANNOT_CREATE_PDF_DOCUMENT)
+            throw new PdfOcrException(PdfOcrExceptionMessageConstant.CANNOT_CREATE_PDF_DOCUMENT)
                     .setMessageParams(e.getMessage());
         }
         if (layers[1] != null) {
@@ -427,9 +428,9 @@ private PdfDocument createPdfDocument(final PdfWriter pdfWriter,
                 && !ocrPdfCreatorProperties.getPdfLang().equals("");
         if (createPdfA3u && !hasPdfLangProperty) {
             LOGGER.error(MessageFormatUtil.format(
-                    OcrException.CANNOT_CREATE_PDF_DOCUMENT,
+                    PdfOcrExceptionMessageConstant.CANNOT_CREATE_PDF_DOCUMENT,
                     PdfOcrLogMessageConstant.PDF_LANGUAGE_PROPERTY_IS_NOT_SET));
-            throw new OcrException(OcrException.CANNOT_CREATE_PDF_DOCUMENT)
+            throw new PdfOcrException(PdfOcrExceptionMessageConstant.CANNOT_CREATE_PDF_DOCUMENT)
                     .setMessageParams(PdfOcrLogMessageConstant.PDF_LANGUAGE_PROPERTY_IS_NOT_SET);
         }
 
@@ -472,13 +473,13 @@ private PdfDocument createPdfDocument(final PdfWriter pdfWriter,
      *                       map pageNumber -> text for the page
      * @param pdfDocument result {@link com.itextpdf.kernel.pdf.PdfDocument}
      * @param createPdfA3u true if PDF/A3u document is being created
-     * @throws OcrException if input image cannot be read or provided font
+     * @throws PdfOcrException if input image cannot be read or provided font
      * contains NOTDEF glyphs
      */
     private void addDataToPdfDocument(
             final Map<File, Map<Integer, List<TextInfo>>> imagesTextData,
             final PdfDocument pdfDocument,
-            final boolean createPdfA3u) throws OcrException {
+            final boolean createPdfA3u) throws PdfOcrException {
         for (Map.Entry<File, Map<Integer, List<TextInfo>>> entry
                 : imagesTextData.entrySet()) {
             File inputImage = entry.getKey();
@@ -545,7 +546,7 @@ private void addImageToCanvas(final ImageData imageData,
      * @param pdfCanvas canvas to place the text
      * @param multiplier coefficient to adjust text placing on canvas
      * @param pageMediaBox page parameters
-     * @throws OcrException if PDF/A3u document is being created and provided
+     * @throws PdfOcrException if PDF/A3u document is being created and provided
      * font contains notdef glyphs
      */
     private void addTextToCanvas(
@@ -554,7 +555,7 @@ private void addTextToCanvas(
             final PdfCanvas pdfCanvas,
             final float multiplier,
             final Rectangle pageMediaBox)
-            throws OcrException {
+            throws PdfOcrException {
         if (pageText != null && pageText.size() > 0) {
             final Point imageCoordinates =
                     PdfCreatorUtil.calculateImageCoordinates(
@@ -750,7 +751,7 @@ public PdfCanvas showText(GlyphLine text) {
                     if (this.createPdfA3u) {
                         // exception is thrown only if PDF/A document is
                         // being created
-                        throw new OcrException(message);
+                        throw new PdfOcrException(message);
                     }
                     // setting actual text to NotDef glyph
                     glyphLine.setActualTextToGlyph(i,

pdfocr-api/src/main/java/com/itextpdf/pdfocr/PdfCreatorUtil.java

@@ -38,7 +38,9 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.layout.LayoutResult;
 import com.itextpdf.layout.renderer.IRenderer;
 import com.itextpdf.layout.renderer.ParagraphRenderer;
-import com.itextpdf.pdfocr.exceptions.OcrException;
+import com.itextpdf.pdfocr.exceptions.PdfOcrException;
+import com.itextpdf.pdfocr.exceptions.PdfOcrExceptionMessageConstant;
+import com.itextpdf.pdfocr.exceptions.PdfOcrInputException;
 import com.itextpdf.pdfocr.logs.PdfOcrLogMessageConstant;
 
 import java.io.File;
@@ -80,12 +82,12 @@ class PdfCreatorUtil {
      * @param bboxHeightPt height of bbox calculated by OCR Reader
      * @param bboxWidthPt width of bbox calculated by OCR Reader
      * @return font size
-     * @throws OcrException if set font provider is invalid and/or fonts that
+     * @throws PdfOcrException if set font provider is invalid and/or fonts that
      * it contains are invalid
      */
     static float calculateFontSize(final Document document, final String line,
             final String fontFamily, final float bboxHeightPt,
-            final float bboxWidthPt) throws OcrException {
+            final float bboxWidthPt) throws PdfOcrException {
         Rectangle bbox = new Rectangle(bboxWidthPt * 1.5f,
                 bboxHeightPt * 1.5f);
         // setting minimum and maximum (approx.) values for font size
@@ -113,8 +115,8 @@ static float calculateFontSize(final Document document, final String line,
         } catch (IllegalStateException e) {
             LOGGER.error(PdfOcrLogMessageConstant
                     .PROVIDED_FONT_PROVIDER_IS_INVALID);
-            throw new OcrException(
-                    OcrException.CANNOT_RESOLVE_PROVIDED_FONTS, e);
+            throw new PdfOcrInputException(
+                    PdfOcrExceptionMessageConstant.CANNOT_RESOLVE_PROVIDED_FONTS, e);
         }
         return fontSize;
     }
@@ -171,11 +173,11 @@ static com.itextpdf.kernel.geom.Point calculateImageCoordinates(
      * @param imageRotationHandler image rotation handler {@link IImageRotationHandler}
      * @return list of {@link com.itextpdf.io.image.ImageData} objects
      * (more than one element in the list if it is a multipage tiff)
-     * @throws OcrException if error occurred during reading a file
+     * @throws PdfOcrException if error occurred during reading a file
      * @throws IOException if error occurred during reading a file
      */
     static List<ImageData> getImageData(final File inputImage, IImageRotationHandler imageRotationHandler)
-            throws OcrException {
+            throws PdfOcrException {
         List<ImageData> images = new ArrayList<ImageData>();
 
         try (InputStream imageStream = new FileInputStream(inputImage)) {
@@ -205,8 +207,8 @@ static List<ImageData> getImageData(final File inputImage, IImageRotationHandler
             LOGGER.error(MessageFormatUtil.format(
                     PdfOcrLogMessageConstant.CANNOT_READ_INPUT_IMAGE,
                     e.getMessage()));
-            throw new OcrException(
-                    OcrException.CANNOT_READ_INPUT_IMAGE, e);
+            throw new PdfOcrInputException(
+                    PdfOcrExceptionMessageConstant.CANNOT_READ_INPUT_IMAGE, e);
         }
         return images;
     }

pdfocr-api/src/main/java/com/itextpdf/pdfocr/exceptions/OcrException.java renamed to pdfocr-api/src/main/java/com/itextpdf/pdfocr/exceptions/PdfOcrException.java

@@ -31,47 +31,50 @@ This file is part of the iText (R) project.
 /**
  * Exception class for custom exceptions.
  */
-public class OcrException extends ITextException {
-
-    public static final String CANNOT_READ_INPUT_IMAGE =
-            "Cannot read input image";
-    public static final String CANNOT_RESOLVE_PROVIDED_FONTS = "Cannot resolve "
-            + "any of provided fonts. Please check provided FontProvider.";
-    public static final String CANNOT_CREATE_PDF_DOCUMENT = "Cannot create "
-            + "PDF document: {0}";
-    public static final String STATISTICS_EVENT_TYPE_CANT_BE_NULL = "Statistics event type can't be null";
-    public static final String STATISTICS_EVENT_TYPE_IS_NOT_DETECTED = "Statistics event type is not detected.";
+public class PdfOcrException extends ITextException {
+
     private List<String> messageParams;
 
     /**
-     * Creates a new OcrException.
+     * Creates a new {@link PdfOcrException}.
      *
      * @param msg the detail message.
      * @param e   the cause
      *            (which is saved for later retrieval
      *            by {@link #getCause()} method).
      */
-    public OcrException(String msg, Throwable e) {
+    public PdfOcrException(String msg, Throwable e) {
         super(msg, e);
     }
 
     /**
-     * Creates a new OcrException.
+     * Creates a new {@link PdfOcrException}.
      *
      * @param msg the detail message.
      */
-    public OcrException(String msg) {
+    public PdfOcrException(String msg) {
         super(msg);
     }
 
+    /**
+     * Creates a new {@link PdfOcrException}.
+     *
+     * @param e the cause
+     *          which is saved for later retrieval
+     *          by {@link #getCause()} method).
+     */
+    public PdfOcrException(Throwable e) {
+        super(e);
+    }
+
     /**
      * {@inheritDoc}
      */
     @Override
     public String getMessage() {
         return this.messageParams != null && this.messageParams.size() != 0
                 ? MessageFormatUtil
-                        .format(super.getMessage(), this.getMessageParams())
+                .format(super.getMessage(), this.getMessageParams())
                 : super.getMessage();
     }
 
@@ -94,7 +97,7 @@ protected Object[] getMessageParams() {
      * @param messageParams additional params.
      * @return object itself.
      */
-    public OcrException setMessageParams(String... messageParams) {
+    public PdfOcrException setMessageParams(String... messageParams) {
         this.messageParams = Arrays.<String>asList(messageParams);
         return this;
     }

pdfocr-api/src/main/java/com/itextpdf/pdfocr/exceptions/PdfOcrExceptionMessageConstant.java

@@ -0,0 +1,37 @@
+/*
+    This file is part of the iText (R) project.
+    Copyright (c) 1998-2021 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 <https://www.gnu.org/licenses/>.
+ */
+package com.itextpdf.pdfocr.exceptions;
+
+public class PdfOcrExceptionMessageConstant {
+
+    public static final String CANNOT_READ_INPUT_IMAGE = "Cannot read input image";
+    public static final String CANNOT_RESOLVE_PROVIDED_FONTS =
+            "Cannot resolve any of provided fonts. Please check provided FontProvider.";
+    public static final String CANNOT_CREATE_PDF_DOCUMENT = "Cannot create PDF document: {0}";
+    public static final String STATISTICS_EVENT_TYPE_CANT_BE_NULL = "Statistics event type can't be null";
+    public static final String STATISTICS_EVENT_TYPE_IS_NOT_DETECTED = "Statistics event type is not detected.";
+
+    private PdfOcrExceptionMessageConstant() {
+        //Private constructor will prevent the instantiation of this class directly
+    }
+}