net.gini.android.capture.network.model

Class GiniCaptureSpecificExtraction

java.lang.Object

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

net.gini.android.capture.network.model.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.

Field Summary

Fields

Modifier and Type	Field and Description
static <any>	CREATOR

Constructor Summary

Constructors

Constructor and Description
GiniCaptureSpecificExtraction(java.lang.String name, java.lang.String value, java.lang.String entity, GiniCaptureBox box, java.util.List candidates) Value object for a specific extraction from the Gini API.

Method Summary

Modifier and Type	Method and Description
int	describeContents()
java.util.List	getCandidates()
java.lang.String	getName()
java.lang.String	toString()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class net.gini.android.capture.network.model.GiniCaptureExtraction

getBox, getEntity, getValue, isDirty, setBox, setIsDirty, setValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final <any> CREATOR

Constructor Detail

GiniCaptureSpecificExtraction

public GiniCaptureSpecificExtraction(java.lang.String name,
                                     java.lang.String value,
                                     java.lang.String entity,
                                     GiniCaptureBox box,
                                     java.util.List candidates)

Value object for a specific extraction from the Gini API.

Parameters:

name - The specific extraction's name, e.g. "amountToPay". See Available Specific Extractions for a full list

value - normalized textual representation of the text/information provided by the extraction value (e.g. bank number without spaces between the digits). Changing this value marks the extraction as dirty

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

box - (optional) bounding box containing the position of the extraction value on the document. Only available for some extractions. Changing this value marks the extraction as dirty

candidates - A list containing other candidates for this specific extraction. Candidates are of the same entity as the found extraction

Method Detail

describeContents

public int describeContents()

Overrides:

describeContents in class GiniCaptureExtraction

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Overrides:

writeToParcel in class GiniCaptureExtraction

getName

public java.lang.String getName()

Returns:

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

getCandidates

public java.util.List getCandidates()

Returns:

a list containing other candidates for this specific extraction

toString

public java.lang.String toString()

Overrides:

toString in class GiniCaptureExtraction