ginicapture/net.gini.android.capture.network.model/GiniCaptureExtraction

GiniCaptureExtraction

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

public class GiniCaptureExtraction implements Parcelable

Constructors

GiniCaptureExtraction

androidJvm

Value object for an extraction from the Gini API.

void GiniCaptureExtraction(String value, String entity, GiniCaptureBox box)

Functions

describeContents

androidJvm

abstract int describeContents()

int describeContents()

getBox

androidJvm

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

synchronized GiniCaptureBox getBox()

getEntity

androidJvm

key (primary identification) of an entity type (e.g. banknumber). See Extraction Entities for a full list

synchronized String getEntity()

getValue

androidJvm

normalized textual representation of the text/information provided by the extraction value (e.g. bank number without spaces between the digits)

synchronized String getValue()

isDirty

androidJvm

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

synchronized boolean isDirty()

setBox

androidJvm

Set a new bounding box. Marks the extraction as dirty.

synchronized void setBox(GiniCaptureBox newBox)

setIsDirty

androidJvm

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

synchronized void setIsDirty(boolean isDirty)

setValue

androidJvm

Set a new value for this extraction. Marks the extraction as dirty.

synchronized void setValue(String newValue)

toString

androidJvm

String toString()

writeToParcel

androidJvm

abstract void writeToParcel(Parcel p, int p1)

void writeToParcel(Parcel dest, int flags)

Properties

CREATOR

androidJvm

public final static Parcelable.Creator<GiniCaptureExtraction> CREATOR

Inheritors

GiniCaptureSpecificExtraction

androidJvm