io.scanbot.sdk.ocr.process

Class OcrResult

io.scanbot.sdk.ocr.process.OcrResult

public class OcrResult

Represents result of OCR-performing. Optionally contains sandwiched pdf file

Field Detail

sandwichedPdfDocument

@JvmField
 @Nullable
public io.scanbot.sdk.entity.Document sandwichedPdfDocument

Optional sandwiched pdf

Document (can be null)

sandwichedPdfDocumentFile

@JvmField
 @Nullable
public java.io.File sandwichedPdfDocumentFile

Optional sandwiched pdf

Document file (can be null)

ocrPages

@JvmField
 @NotNull
public java.util.List<io.scanbot.sdk.ocr.process.OcrResult.OCRPage> ocrPages

List of pages with OCR data

Constructor Detail

OcrResult

public OcrResult(@Nullable
                 io.scanbot.sdk.entity.Document sandwichedPdfDocument,
                 @Nullable
                 java.io.File sandwichedPdfDocumentFile,
                 @NotNull
                 java.util.List<io.scanbot.sdk.ocr.process.OcrResult.OCRPage> ocrPages)

Represents result of OCR-performing. Optionally contains sandwiched pdf file

Parameters:

sandwichedPdfDocument - Optional sandwiched pdf Document (can be null)

sandwichedPdfDocumentFile - Optional sandwiched pdf Document file (can be null)

ocrPages - List of pages with OCR data

OcrResult

public OcrResult()

Represents result of OCR-performing. Optionally contains sandwiched pdf file

Method Detail

getRecognizedText

@NotNull
public java.lang.String getRecognizedText()

Returns:

recognized test for all pages

component1

@Nullable
public io.scanbot.sdk.entity.Document component1()

Optional sandwiched pdf

Document (can be null)

component2

@Nullable
public java.io.File component2()

Optional sandwiched pdf

Document file (can be null)

component3

@NotNull
public java.util.List<io.scanbot.sdk.ocr.process.OcrResult.OCRPage> component3()

List of pages with OCR data

copy

@NotNull
public OcrResult copy(@Nullable
                               io.scanbot.sdk.entity.Document sandwichedPdfDocument,
                               @Nullable
                               java.io.File sandwichedPdfDocumentFile,
                               @NotNull
                               java.util.List<io.scanbot.sdk.ocr.process.OcrResult.OCRPage> ocrPages)

Represents result of OCR-performing. Optionally contains sandwiched pdf file

toString

@NotNull
public java.lang.String toString()

hashCode

public int hashCode()

equals

public boolean equals(@Nullable
                      java.lang.Object p)