GiniCaptureExtraction

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).

Constructors

GiniCaptureExtraction

void GiniCaptureExtraction(@NonNull() String value, @NonNull() String entity, @Nullable() GiniCaptureBox box)

Value object for an extraction from the Gini API.

Functions

describeContents

int describeContents()

getBox

synchronized GiniCaptureBox getBox()

bounding box containing the position of the extraction value on the document

getEntity

synchronized String getEntity()

key (primary identification) of an entity type (e.g.

getValue

synchronized String getValue()

normalized textual representation of the text/information provided by the extraction value (e.g.

isDirty

synchronized boolean isDirty()

{@code true} if the value or the bounding box has been changed

setBox

synchronized void setBox(@Nullable() GiniCaptureBox newBox)

Set a new bounding box.

setIsDirty

synchronized void setIsDirty(boolean isDirty)

pass {@code true} to mark the extraction as dirty

setValue

synchronized void setValue(@NonNull() String newValue)

Set a new value for this extraction.

toString

String toString()

writeToParcel

void writeToParcel(Parcel dest, int flags)

Properties

CREATOR

public final static Parcelable.Creator<GiniCaptureExtraction> CREATOR

Inheritors

GiniCaptureSpecificExtraction