GiniCaptureSpecificExtraction

public class GiniCaptureSpecificExtraction extends GiniCaptureExtraction

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.

Constructors

GiniCaptureSpecificExtraction

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

Value object for a specific extraction from the Gini API.

Functions

describeContents

abstract int describeContents()

int describeContents()

getBox

@Nullable()

synchronized GiniCaptureBox getBox()

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

getCandidates

@NonNull()

List<GiniCaptureExtraction> getCandidates()

a list containing other candidates for this specific extraction

getEntity

@NonNull()

synchronized String getEntity()

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

getName

@NonNull()

String getName()

the specific extraction's name.

getValue

@NonNull()

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

@NonNull()

String toString()

writeToParcel

abstract void writeToParcel(Parcel p, int p1)

void writeToParcel(Parcel dest, int flags)

Properties

CREATOR

public final static Parcelable.Creator<GiniCaptureSpecificExtraction> CREATOR