GiniCaptureExtraction 3.19.1 API

All Implemented Interfaces:

android.os.Parcelable
```
public class GiniCaptureExtraction
 implements Parcelable
                    
```
Contains a Gini API extraction.
An extraction contains an entity describing the general semantic type of the extraction (e.g. a date), which also determines the format of the value containing the information as text. Optionally there may be a box describing the position of the extraction value on the document. In most instances, extractions without a bounding box are meta information (e.g. doctype).

Field Summary

Fields
Modifier and Type	Field	Description
`public final static Parcelable.Creator<GiniCaptureExtraction>`	`CREATOR`

Constructor Summary

Constructors
Constructor	Description
`GiniCaptureExtraction(String value, String entity, GiniCaptureBox box)`	Value object for an extraction from the Gini API.

Method Summary

Modifier and Type	Method	Description
`int`	`describeContents()`
`void`	`writeToParcel(Parcel dest, int flags)`
`synchronized String`	`getValue()`
`synchronized void`	`setValue(@NonNull() String newValue)`	Set a new value for this extraction.
`synchronized String`	`getEntity()`
`synchronized GiniCaptureBox`	`getBox()`
`synchronized void`	`setBox(@Nullable() GiniCaptureBox newBox)`	Set a new bounding box.
`synchronized boolean`	`isDirty()`
`synchronized void`	`setIsDirty(boolean isDirty)`
`String`	`toString()`

Methods inherited from class android.os.Parcelable
describeContents, writeToParcel
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GiniCaptureExtraction
```
GiniCaptureExtraction(String value, String entity, GiniCaptureBox box)
```
    Value object for an extraction from the Gini API.
    
    Parameters:
    
    value - normalized textual representation of the text/information provided by theextraction value (e.g.
    
    entity - key (primary identification) of an entity type (e.g.
    
    box - (optional) bounding box containing the position of the extraction value on thedocument.
- Method Detail
  - describeContents
```
 int describeContents()
```
  - writeToParcel
```
 void writeToParcel(Parcel dest, int flags)
```
  - getValue
```
@NonNull() synchronized String getValue()
```
  - setValue
```
 synchronized void setValue(@NonNull() String newValue)
```
    Set a new value for this extraction. Marks the extraction as dirty.
    
    Parameters:
    
    newValue - new value
  - getEntity
```
@NonNull() synchronized String getEntity()
```
  - getBox
```
@Nullable() synchronized GiniCaptureBox getBox()
```
  - setBox
```
 synchronized void setBox(@Nullable() GiniCaptureBox newBox)
```
    Set a new bounding box. Marks the extraction as dirty.
    
    Parameters:
    
    newBox - new bounding box
  - isDirty
```
 synchronized boolean isDirty()
```
  - setIsDirty
```
 synchronized void setIsDirty(boolean isDirty)
```
    Parameters:
    
    isDirty - pass {@code true} to mark the extraction as dirty
  - toString
```
 String toString()
```