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

GiniCaptureSpecificExtraction

Contains a Gini API specific extraction.

A specific extraction assings a semantic property to an extraction and it may contain a list of extraction candidates.

The extraction candidates are other suggestions for this specific extraction (e.g. all amounts on the document). Candidates are of the same entity as the found extraction.

public class GiniCaptureSpecificExtraction extends GiniCaptureExtraction

Constructors

GiniCaptureSpecificExtraction

androidJvm

Value object for a specific extraction from the Gini API.

void GiniCaptureSpecificExtraction(String name, String value, String entity, GiniCaptureBox box, List<GiniCaptureExtraction> candidates)

Functions

describeContents

androidJvm

abstract int describeContents()

int describeContents()

getBox

androidJvm

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

@Nullable()

synchronized GiniCaptureBox getBox()

getCandidates

androidJvm

a list containing other candidates for this specific extraction

@NonNull()

List<GiniCaptureExtraction> getCandidates()

getEntity

androidJvm

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

@NonNull()

synchronized String getEntity()

getName

androidJvm

the specific extraction's name. See Available Specific Extractions for a full list

@NonNull()

String getName()

getValue

androidJvm

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

@NonNull()

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

@NonNull()

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<GiniCaptureSpecificExtraction> CREATOR