com.itextpdf.pdfocr.tesseract4.actions.events.PdfOcrTesseract4ProductEvent Maven / Gradle / Ivy

Go to download
/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2023 Apryse Group NV
    Authors: Apryse 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.tesseract4.actions.events;

import com.itextpdf.commons.actions.AbstractProductProcessITextEvent;
import com.itextpdf.commons.actions.confirmations.EventConfirmationType;
import com.itextpdf.commons.actions.contexts.IMetaInfo;
import com.itextpdf.commons.actions.sequence.SequenceId;
import com.itextpdf.pdfocr.tesseract4.actions.data.PdfOcrTesseract4ProductData;

/**
 * Class represents events registered in iText pdfOcr Tesseract4 module.
 */
public class PdfOcrTesseract4ProductEvent extends AbstractProductProcessITextEvent {
    /**
     * Process image event type.
     */
    public static final String PROCESS_IMAGE = "process-image";

    private final String eventType;

    /**
     * Creates an event associated with a general identifier and additional meta data.
     *
     * @param sequenceId            is an identifier associated with the event
     * @param metaInfo              is an additional meta info
     * @param eventType             is a string description of the event
     * @param eventConfirmationType is an event confirmation type
     */
    private PdfOcrTesseract4ProductEvent(SequenceId sequenceId, IMetaInfo metaInfo, String eventType,
            EventConfirmationType eventConfirmationType) {
        super(sequenceId, PdfOcrTesseract4ProductData.getInstance(), metaInfo, eventConfirmationType);
        this.eventType = eventType;
    }

    /**
     * Creates process-image event.
     *
     * @param sequenceId            is an identifier associated with the event
     * @param metaInfo              is an additional meta info
     * @param eventConfirmationType is an event confirmation type
     *
     * @return process-image event
     */
    public static PdfOcrTesseract4ProductEvent createProcessImageEvent(SequenceId sequenceId,
            IMetaInfo metaInfo, EventConfirmationType eventConfirmationType) {
        return new PdfOcrTesseract4ProductEvent(sequenceId, metaInfo, PROCESS_IMAGE, eventConfirmationType);
    }

    @Override
    public String getEventType() {
        return eventType;
    }
}