All Implemented Interfaces:: android.os.Parcelable , java.lang.AutoCloseable


public final class Field
 implements AutoCloseable, Parcelable

Generic document field.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final FieldType`	`type`
`private final OcrResult`	`value`
`private final Double`	`confidenceWeight`
`private final ImageRef`	`image`
`private final List<PointF>`	`polygonInRoot`
`private final FieldValidationStatus`	`validationStatus`
`private final List<FieldParsedData>`	`parsedData`

Constructor Summary

Constructors
Constructor	Description
`Field(Map<String, Object> source)`
`Field(JSONObject json)`
`Field(FieldType type, OcrResult value, Double confidenceWeight, ImageRef image, List<PointF> polygonInRoot, FieldValidationStatus validationStatus, List<FieldParsedData> parsedData)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final FieldType`	`getType()`	The type of the field.
`final OcrResult`	`getValue()`	Value of the field.
`final Double`	`getConfidenceWeight()`	Confidence weight.
`final ImageRef`	`getImage()`	Crop of the field.
`final List<PointF>`	`getPolygonInRoot()`	Coordinates of the field in the root document coordinate system.
`final FieldValidationStatus`	`getValidationStatus()`	Field validation status.
`final List<FieldParsedData>`	`getParsedData()`	Parsed data.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final Field`	`clone()`
`Unit`	`close()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Field
```
Field(Map<String, Object> source)
```

Field
```
Field(JSONObject json)
```

Field

Field(FieldType type, OcrResult value, Double confidenceWeight, ImageRef image, List<PointF> polygonInRoot, FieldValidationStatus validationStatus, List<FieldParsedData> parsedData)

Method Detail
- getType
```
 final FieldType getType()
```
  The type of the field.
- getValue
```
 final OcrResult getValue()
```
  Value of the field. Applicable only to text fields.
- getConfidenceWeight
```
 final Double getConfidenceWeight()
```
  Confidence weight.
  Default is 1.0
- getImage
```
 final ImageRef getImage()
```
  Crop of the field.
- getPolygonInRoot
```
 final List<PointF> getPolygonInRoot()
```
  Coordinates of the field in the root document coordinate system.
- getValidationStatus
```
 final FieldValidationStatus getValidationStatus()
```
  Field validation status. Applicable only to fields that support some kind of validation.
  Default is NONE
- getParsedData
```
 final List<FieldParsedData> getParsedData()
```
  Parsed data.
- toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
- clone
```
 final Field clone()
```
- close
```
 Unit close()
```

Class Field

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Field

Field

Field

Method Detail

getType

getValue

getConfidenceWeight

getImage

getPolygonInRoot

getValidationStatus

getParsedData

toJson

clone

close