net.gini.android.vision.network.model

Class GiniVisionExtraction

java.lang.Object

net.gini.android.vision.network.model.GiniVisionExtraction

Direct Known Subclasses:

GiniVisionSpecificExtraction

public class GiniVisionExtraction
extends java.lang.Object

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

Field Summary

Fields

Modifier and Type	Field and Description
static <any>	CREATOR

Constructor Summary

Constructors

Constructor and Description
GiniVisionExtraction(java.lang.String value, java.lang.String entity, GiniVisionBox box) Value object for an extraction from the Gini API.

Method Summary

Modifier and Type	Method and Description
int	describeContents()
GiniVisionBox	getBox()
java.lang.String	getEntity()
java.lang.String	getValue()
boolean	isDirty()
void	setBox(GiniVisionBox newBox) Set a new bounding box.
void	setIsDirty(boolean isDirty)
void	setValue(java.lang.String newValue) Set a new value for this extraction.
java.lang.String	toString()
void	writeToParcel(Parcel dest, int flags)

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

GiniVisionExtraction

public GiniVisionExtraction(java.lang.String value,
                            java.lang.String entity,
                            GiniVisionBox box)

Value object for an extraction from the Gini API.

Parameters:

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

Method Detail

describeContents

public int describeContents()

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

getValue

public java.lang.String getValue()

Returns:

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

setValue

public void setValue(java.lang.String newValue)

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

Parameters:

newValue - new value

getEntity

public java.lang.String getEntity()

Returns:

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

getBox

public GiniVisionBox getBox()

Returns:

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

setBox

public void setBox(GiniVisionBox newBox)

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

Parameters:

newBox - new bounding box

isDirty

public boolean isDirty()

Returns:

true if the value or the bounding box has been changed

setIsDirty

public void setIsDirty(boolean isDirty)

Parameters:

isDirty - pass true to mark the extraction as dirty

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object