net.gini.android.vision.network

Class GiniVisionDefaultNetworkService

java.lang.Object

net.gini.android.vision.network.GiniVisionDefaultNetworkService

All Implemented Interfaces:

GiniVisionNetworkService

public class GiniVisionDefaultNetworkService
extends java.lang.Object
implements GiniVisionNetworkService

Default implementation of the network related tasks required by the Gini Vision Library.

Relies on the Gini API SDK for executing the requests, which implements communication with the Gini API using generated anonymous Gini users.

Important: Access to the Gini User Center API is required which is restricted to selected clients only. Contact Gini if you require access.

To create an instance use the GiniVisionDefaultNetworkService.Builder returned by the GiniVisionDefaultNetworkService.builder(Context) method.

In order for the Gini Vision Library to use this implementation pass an instance of it to GiniVision.Builder#setGiniVisionNetworkService(GiniVisionNetworkService) when creating a GiniVision instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GiniVisionDefaultNetworkService.Builder Builder for configuring a new instance of the GiniVisionDefaultNetworkService.

Method Summary

Modifier and Type	Method and Description
CancellationToken	analyze(java.util.LinkedHashMap giniApiDocumentIdRotationMap, GiniVisionNetworkCallback callback) Called when a document needs to be analyzed by the Gini API.
static GiniVisionDefaultNetworkService.Builder	builder(Context context) Creates a new GiniVisionDefaultNetworkService.Builder to configure and create a new instance.
void	cleanup() Called when the Gini Vision Library is not needed anymore and the GiniVision#cleanup(Context) method has been called.
CancellationToken	delete(java.lang.String giniApiDocumentId, GiniVisionNetworkCallback callback) Called when a document needs to be deleted from the Gini API.
CancellationToken	upload(Document document, GiniVisionNetworkCallback callback) Called when a document needs to be uploaded to the Gini API.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static GiniVisionDefaultNetworkService.Builder builder(Context context)

Creates a new GiniVisionDefaultNetworkService.Builder to configure and create a new instance.

Parameters:

context - Android context

Returns:

a new GiniVisionDefaultNetworkService.Builder

upload

public CancellationToken upload(Document document,
                                GiniVisionNetworkCallback callback)

Description copied from interface: GiniVisionNetworkService

Called when a document needs to be uploaded to the Gini API.

You should only upload the document. Polling or retrieving extractions is not needed at this point.

Specified by:

upload in interface GiniVisionNetworkService

Parameters:

document - a Document containing an image, pdf or other supported formats

callback - a callback implementation to return the outcome of the upload

Returns:

a CancellationToken to be used for requesting upload cancellation

delete

public CancellationToken delete(java.lang.String giniApiDocumentId,
                                GiniVisionNetworkCallback callback)

Description copied from interface: GiniVisionNetworkService

Called when a document needs to be deleted from the Gini API.

Specified by:

delete in interface GiniVisionNetworkService

Parameters:

giniApiDocumentId - id of the document received when it was uploaded to the Gini API

callback - a callback implementation to return the outcome of the deletion

Returns:

a CancellationToken to be used for requesting cancellation of the deletion

analyze

public CancellationToken analyze(java.util.LinkedHashMap giniApiDocumentIdRotationMap,
                                 GiniVisionNetworkCallback callback)

Description copied from interface: GiniVisionNetworkService

Called when a document needs to be analyzed by the Gini API.

The documents were already uploaded and only the Gini API document ids of documents are passed in along with the user applied document rotations.

Specified by:

analyze in interface GiniVisionNetworkService

Parameters:

giniApiDocumentIdRotationMap - a map of Gini API document ids and the user applied document rotations

callback - a callback implementation to return the outcome of the analysis

Returns:

a CancellationToken to be used for requesting analysis cancellation

cleanup

public void cleanup()

Description copied from interface: GiniVisionNetworkService

Called when the Gini Vision Library is not needed anymore and the GiniVision#cleanup(Context) method has been called.

Free up any resources your implementation is using.

Specified by:

cleanup in interface GiniVisionNetworkService