com.aspose.ocr

Class OcrOutput

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<RecognitionResult>

com.aspose.ocr.OcrOutput

All Implemented Interfaces:

Serializable, Cloneable, Iterable<RecognitionResult>, Collection<RecognitionResult>, List<RecognitionResult>, RandomAccess

public class OcrOutput
extends ArrayList<RecognitionResult>

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
OcrOutput() Initializes a new instance of the OcrOutput class with an empty collection.

Method Summary

Modifier and Type	Method and Description
boolean	addAll(Collection<? extends RecognitionResult> collection) Overrides addAll to add the elements of the specified collection to the end of the OcrOutput list.
void	save(OutputStream stream) Save all recognition results to a memory stream in the specified format.
void	save(OutputStream stream, Format saveFormat) Save all recognition results to a memory stream in the specified format.
void	save(OutputStream stream, Format saveFormat, String embeddedFontPath, PdfOptimizationMode optimizePdf) Save all recognition results to a memory stream in the specified format.
void	save(String fullFileName) Save all recognition result to a file.
void	save(String fullFileName, Format saveFormat) Save all recognition result to a file.
void	save(String fullFileName, Format saveFormat, String embeddedFontPath, PdfOptimizationMode optimizePdf) Save all recognition result to a file.
void	savePdf(OutputStream stream) Save all recognition results into an in-memory searchable PDF document, embedding the original images as the background.
void	savePdf(OutputStream stream, String embeddedFontPath, PdfOptimizationMode optimizePdf) Save all recognition results into an in-memory searchable PDF document, embedding the original images as the background.
void	savePdf(String fullFileName) Save all recognition results into a searchable PDF file, with the original images set as the background.
void	savePdf(String fullFileName, String embeddedFontPath, PdfOptimizationMode optimizePdf) Save all recognition results into a searchable PDF file, with the original images set as the background.

Methods inherited from class java.util.ArrayList

add, add, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

OcrOutput

public OcrOutput()

Initializes a new instance of the OcrOutput class with an empty collection. This constructor calls the base class constructor to initialize an empty list of RecognitionResult.

Method Detail

savePdf

public void savePdf(String fullFileName)
             throws IOException,
                    AsposeOCRException

Save all recognition results into a searchable PDF file, with the original images set as the background.

Parameters:

fullFileName - Filename with a path for saving recognition result in the selected format.

Throws:

IOException - if file not found.

AsposeOCRException - if recognition error.

savePdf

public void savePdf(String fullFileName,
                    String embeddedFontPath,
                    PdfOptimizationMode optimizePdf)
             throws IOException,
                    AsposeOCRException

Save all recognition results into a searchable PDF file, with the original images set as the background.

Parameters:

fullFileName - Filename with a path for saving recognition result in the selected format.

embeddedFontPath - Optional. Full path to the user font.

optimizePdf - Reduce the PDF file size by lowering the quality of background images. By default, the original image quality is preserved.

Throws:

IOException - if file not found.

AsposeOCRException - if recognition error.

save

public void save(String fullFileName)

Save all recognition result to a file.

Parameters:

fullFileName - Filename with a path for saving recognition result in the selected format.

save

public void save(String fullFileName,
                 Format saveFormat)

Save all recognition result to a file.

Parameters:

fullFileName - Filename with a path for saving recognition result in the selected format.

saveFormat - Document format (Docx, Txt, Pdf, Xlsx, Rtf, Json, Xml, Epub).

save

public void save(String fullFileName,
                 Format saveFormat,
                 String embeddedFontPath,
                 PdfOptimizationMode optimizePdf)

Save all recognition result to a file.

Parameters:

fullFileName - Filename with a path for saving recognition result in the selected format.

saveFormat - Document format (Docx, Txt, Pdf, Xlsx, Rtf, Json, Xml, Epub).

embeddedFontPath - Optional. Full path to the user font.

optimizePdf - Reduce the PDF file size by lowering the quality of background images. By default, the original image quality is preserved.

savePdf

public void savePdf(OutputStream stream)
             throws IOException,
                    AsposeOCRException

Save all recognition results into an in-memory searchable PDF document, embedding the original images as the background.

Parameters:

stream - OutputStream for saving recognition result in the selected format.

Throws:

IOException - if file not found.

AsposeOCRException - if recognition error.

savePdf

public void savePdf(OutputStream stream,
                    String embeddedFontPath,
                    PdfOptimizationMode optimizePdf)
             throws IOException,
                    AsposeOCRException

Save all recognition results into an in-memory searchable PDF document, embedding the original images as the background.

Parameters:

stream - OutputStream for saving recognition result in the selected format.

embeddedFontPath - Optional. Full path to the user font.

optimizePdf - Reduce the PDF file size by lowering the quality of background images. By default, the original image quality is preserved.

Throws:

IOException - if file not found.

AsposeOCRException - if recognition error.

save

public void save(OutputStream stream)

Save all recognition results to a memory stream in the specified format.

Parameters:

stream - OutputStream for saving recognition result in the selected format.

save

public void save(OutputStream stream,
                 Format saveFormat)

Save all recognition results to a memory stream in the specified format.

Parameters:

stream - OutputStream for saving recognition result in the selected format.

saveFormat - Document format (Docx, Txt, Pdf, Xlsx, Rtf, Json, Xml, Epub).

save

public void save(OutputStream stream,
                 Format saveFormat,
                 String embeddedFontPath,
                 PdfOptimizationMode optimizePdf)

Save all recognition results to a memory stream in the specified format.

Parameters:

stream - OutputStream for saving recognition result in the selected format.

saveFormat - Document format (Docx, Txt, Pdf, Xlsx, Rtf, Json, Xml, Epub).

embeddedFontPath - Optional. Full path to the user font.

optimizePdf - Reduce the PDF file size by lowering the quality of background images. By default, the original image quality is preserved.

addAll

public boolean addAll(Collection<? extends RecognitionResult> collection)

Overrides addAll to add the elements of the specified collection to the end of the OcrOutput list.

Specified by:

addAll in interface Collection<RecognitionResult>

Specified by:

addAll in interface List<RecognitionResult>

Overrides:

addAll in class ArrayList<RecognitionResult>

Parameters:

collection - The collection of RecognitionResult to add.

Returns:

true if the collection was modified as a result of the operation.