GenericDocument

io.scanbot.genericdocument.entity.GenericDocument

```
public class GenericDocument
```
A generic document. Contains fields and sub-documents.
To get access to convenient field getters for a specific document types, use class GenericDocumentLibrary
The usage is the following: val genericDocument: GenericDocument val wrapper = GenericDocumentLibrary.wrapperFromGenericDocument(genericDocument)
The wrapper variable will be the type of the corresponding document, for example class DeIdCardFront

See Also:

class GenericDocumentLibrary, class DeIdCardFront

Constructor Detail
- GenericDocument
```
public GenericDocument(@NotNull
                       io.scanbot.genericdocument.entity.GenericDocument.Type type,
                       @NotNull
                       java.util.List<io.scanbot.genericdocument.entity.Field> fields,
                       @NotNull
                       java.util.List<io.scanbot.genericdocument.entity.GenericDocument> children,
                       float confidence,
                       float confidenceWeight)
```
  A generic document. Contains fields and sub-documents.
  To get access to convenient field getters for a specific document types, use class GenericDocumentLibrary
  The usage is the following: val genericDocument: GenericDocument val wrapper = GenericDocumentLibrary.wrapperFromGenericDocument(genericDocument)
  The wrapper variable will be the type of the corresponding document, for example class DeIdCardFront
  
  Parameters:
  
  type - document type
  
  fields - a list of document fields
  
  children - a list of sub-documents
  
  confidence - the average confidence in the accuracy of the document recognition result
  
  confidenceWeight - the weight of the confidence. Can be used to calculate the weighted average confidence of two documents.
  
  See Also:
  
  class GenericDocumentLibrary, class DeIdCardFront

Method Detail

fieldByTypeName

@Nullable
public Field fieldByTypeName(@NotNull
                                       java.lang.String name)

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

fieldsByTypeName

@NotNull
public java.util.List<io.scanbot.genericdocument.entity.Field> fieldsByTypeName(@NotNull
                                                                                         java.lang.String name)

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

childByDocumentType

@Nullable
public GenericDocument childByDocumentType(@NotNull
                                                     java.lang.String name)

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

getType

@NotNull
public io.scanbot.genericdocument.entity.GenericDocument.Type getType()

document type

getFields

@NotNull
public java.util.List<io.scanbot.genericdocument.entity.Field> getFields()

a list of document fields

getChildren

@NotNull
public java.util.List<io.scanbot.genericdocument.entity.GenericDocument> getChildren()

a list of sub-documents

getConfidence
```
public float getConfidence()
```
the average confidence in the accuracy of the document recognition result

getConfidenceWeight
```
public float getConfidenceWeight()
```
the weight of the confidence.
Can be used to calculate the weighted average confidence of two documents.

component1

@NotNull
public io.scanbot.genericdocument.entity.GenericDocument.Type component1()

document type

component2

@NotNull
public java.util.List<io.scanbot.genericdocument.entity.Field> component2()

a list of document fields

component3

@NotNull
public java.util.List<io.scanbot.genericdocument.entity.GenericDocument> component3()

a list of sub-documents

component4
```
public float component4()
```
the average confidence in the accuracy of the document recognition result

component5
```
public float component5()
```
the weight of the confidence.
Can be used to calculate the weighted average confidence of two documents.

copy

@NotNull
public GenericDocument copy(@NotNull
                                     io.scanbot.genericdocument.entity.GenericDocument.Type type,
                                     @NotNull
                                     java.util.List<io.scanbot.genericdocument.entity.Field> fields,
                                     @NotNull
                                     java.util.List<io.scanbot.genericdocument.entity.GenericDocument> children,
                                     float confidence,
                                     float confidenceWeight)

A generic document. Contains fields and sub-documents.

To get access to convenient field getters for a specific document types, use class GenericDocumentLibrary

The usage is the following: val genericDocument: GenericDocument val wrapper = GenericDocumentLibrary.wrapperFromGenericDocument(genericDocument)

The wrapper variable will be the type of the corresponding document, for example class DeIdCardFront

See Also:: class GenericDocumentLibrary, class DeIdCardFront

toString

@NotNull
public java.lang.String toString()

hashCode
```
public int hashCode()
```

equals

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

Class GenericDocument

Constructor Detail