Browse our Products

Aspose.OCR for Java 26.11.0 - Release Notes

What was changed

KeySummaryCategory
OCRJAVA‑487Added page progress reporting and recognition cancellation with partial results for completed pages.New feature

Public API changes and backwards compatibility

This section lists all public API changes introduced in Aspose.OCR for Java 26.11.0 that may affect the code of existing applications.

Added public APIs:

The following public APIs have been introduced in this release:

com.aspose.ocr.AsposeOCR.setOcrProgress - a new method

Registers an OcrRecognizeEventHandler that is called after each successfully recognized page.

MethodDescription
void setOcrProgress(OcrRecognizeEventHandler handler)Sets the page progress handler. Pass null to remove the handler.

com.aspose.ocr.AsposeOCR.Recognize(OcrInput, RecognitionSettings, OcrCancellationToken) - a new overload

Recognizes images or documents with cancellation support. If recognition is canceled, the returned OcrOutput contains results for pages completed before cancellation.

com.aspose.ocr.OcrCancellationToken - a new class

Controls cancellation of a recognition operation.

MethodDescription
void cancel()Requests cancellation.
boolean isCancellationRequested()Returns true when cancellation has been requested.

com.aspose.ocr.OcrPageRecognizeEventsArgs - a new class

Contains progress information for a completed page.

MethodDescription
int getCurrentPage()Returns the zero-based page index.
Duration getDuration()Returns elapsed time from the start of recognition.
String getFileName()Returns the processed file or archive entry name.
String getOperationName()Returns the current operation name.

com.aspose.ocr.OcrRecognizeEventHandler - a new functional interface

Receives page recognition progress notifications through the invoke(OcrPageRecognizeEventsArgs event) method.

Updated public APIs:

No changes.

Removed public APIs:

No changes.

Examples

Report recognition progress

import com.aspose.ocr.AsposeOCR;
import com.aspose.ocr.InputType;
import com.aspose.ocr.OcrInput;
import com.aspose.ocr.OcrOutput;
import com.aspose.ocr.RecognitionSettings;

public class RecognitionProgressExample {
    public static void main(String[] args) throws Exception {
        OcrInput input = new OcrInput(InputType.PDF);
        input.add("document.pdf");

        try (AsposeOCR api = new AsposeOCR()) {
            api.setOcrProgress(event -> System.out.println(
                    "Page: " + event.getCurrentPage()
                            + ", file: " + event.getFileName()
                            + ", operation: " + event.getOperationName()
                            + ", elapsed: " + event.getDuration().toMillis() + " ms"));

            OcrOutput results = api.Recognize(input, new RecognitionSettings());
            System.out.println("Recognized pages: " + results.size());
        }
    }
}

Cancel recognition and keep completed pages

The following example requests cancellation after the third page is completed. Setting the thread count to 1 ensures sequential page processing, so the returned output contains exactly three pages.

import com.aspose.ocr.AsposeOCR;
import com.aspose.ocr.InputType;
import com.aspose.ocr.OcrCancellationToken;
import com.aspose.ocr.OcrInput;
import com.aspose.ocr.OcrOutput;
import com.aspose.ocr.RecognitionSettings;

public class RecognitionCancellationExample {
    public static void main(String[] args) throws Exception {
        OcrInput input = new OcrInput(InputType.PDF);
        input.add("document.pdf");

        RecognitionSettings settings = new RecognitionSettings();
        settings.setThreadsCount(1);

        OcrCancellationToken cancellationToken = new OcrCancellationToken();

        try (AsposeOCR api = new AsposeOCR()) {
            api.setOcrProgress(event -> {
                if (event.getCurrentPage() == 2) {
                    cancellationToken.cancel();
                }
            });

            OcrOutput results = api.Recognize(input, settings, cancellationToken);

            // Pages 0, 1, and 2 were completed before cancellation.
            System.out.println("Recognized pages: " + results.size()); // 3
        }
    }
}