Android Scanbot Barcode SDK API reference/io.scanbot.sdk.genericdocument.entity/GenericDocument

GenericDocument

data class GenericDocument(val type: GenericDocumentType, val fields: List<Field>, val children: List<GenericDocument>, val quad: List<PointF>, val quadInRoot: List<PointF>, val crop: ImageRef? = null, val confidence: Double = 0.0, val confidenceWeight: Double = 0.0) : AutoCloseable, Parcelable

Generic document.

Constructors

GenericDocument

constructor(source: Map<String, Any?>)

constructor(json: JSONObject)

constructor(type: GenericDocumentType, fields: List<Field>, children: List<GenericDocument>, quad: List<PointF>, quadInRoot: List<PointF>, crop: ImageRef? = null, confidence: Double = 0.0, confidenceWeight: Double = 0.0)

Properties

children

val children: List<GenericDocument>

List of document sub-documents.

confidence

val confidence: Double = 0.0

The average confidence in the accuracy of the document recognition result.

confidenceWeight

val confidenceWeight: Double = 0.0

The weight of the confidence. Can be used to calculate the weighted average confidence of two documents.

crop

val crop: ImageRef? = null

Image crop of the document.

fields

val fields: List<Field>

List of document fields.

quad

val quad: List<PointF>

Coordinates of the document in the parent document coordinate system.

quadInRoot

val quadInRoot: List<PointF>

Coordinates of the document in the root document coordinate system.

type

val type: GenericDocumentType

Document type.

Functions

childByDocumentType

fun GenericDocument.childByDocumentType(name: String): GenericDocument?

Returns a sub-document given its document type name. Returns null if not found.

childrenByDocumentType

fun GenericDocument.childrenByDocumentType(name: String): List<GenericDocument>

Returns all children given their document type name.

clone

fun clone(): GenericDocument

open override fun close()

fieldByTypeName

fun GenericDocument.fieldByTypeName(name: String): Field?

Returns a field given its local or common type name. Returns null if not found.

fieldsByTypeName

fun GenericDocument.fieldsByTypeName(name: String): List<Field>

Returns all fields given a local or common field type name.

toJson

fun toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JSONObject

wrap

inline fun GenericDocument.wrap(): GenericDocumentWrapper

An extension function for GenericDocument class