com.evrythng.java.wrapper.service

Class ScanService

java.lang.Object

com.evrythng.java.wrapper.core.EvrythngServiceBase

com.evrythng.java.wrapper.service.ScanService

public class ScanService
extends EvrythngServiceBase

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScanService.IdentifyType
static class	ScanService.ScanMethod

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH_IDENTIFY
static String	PATH_SCAN
static String	PATH_SCAN_BARCODE
static String	PATH_SCAN_RECOGNIZE

Constructor Summary

Constructors

Constructor and Description
ScanService(ApiManager api)

Method Summary

Modifier and Type	Method and Description
EvrythngApiBuilder.Builder<UrlBinding>	identifyCreator(InputStream image, String mime, ScanService.IdentifyType type) POST "/identify"
EvrythngApiBuilder.Builder<UrlBinding>	identifyCreator(String base64Image) POST "/identify"
EvrythngApiBuilder.Builder<UrlBinding>	identifyCreator(String base64Image, ScanService.IdentifyType type) POST "/identify"
EvrythngApiBuilder.Builder<UrlBinding>	identifyCreator(UrlBinding imageInBinding) POST "/identify"
EvrythngApiBuilder.Builder<UrlBinding>	identifyCreator(UrlBinding imageInBinding, ScanService.IdentifyType type) POST "/identify"
EvrythngApiBuilder.Builder<UrlBinding>	recognitionsCreator(InputStream image, String mime, ScanService.ScanMethod... methods) POST "/scan/recognitions"
EvrythngApiBuilder.Builder<UrlBinding>	recognitionsCreator(String base64Image, ScanService.ScanMethod... methods) POST "/scan/recognitions"
EvrythngApiBuilder.Builder<UrlBinding>	recognitionsCreator(UrlBinding imageInBinding, ScanService.ScanMethod... methods) POST "/scan/recognitions"
EvrythngApiBuilder.Builder<UrlBinding>	scanBarcodeCreator(UrlBinding scanBarcodeData) POST "/scan/barcode"

Methods inherited from class com.evrythng.java.wrapper.core.EvrythngServiceBase

absoluteUri, delete, deleteMultiple, encodeBase64, get, getConfig, iterator, mqttUrl, onBuilderCreated, post, post, postAsynchronously, postMultipart, postMultipart, put, put, putMultipart, putMultipart, putMultiple, urlEncodePathPart

Methods inherited from class java.lang.Object

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

Field Detail

PATH_SCAN

public static final String PATH_SCAN

See Also:

Constant Field Values

PATH_SCAN_RECOGNIZE

public static final String PATH_SCAN_RECOGNIZE

See Also:

Constant Field Values

PATH_SCAN_BARCODE

public static final String PATH_SCAN_BARCODE

See Also:

Constant Field Values

PATH_IDENTIFY

public static final String PATH_IDENTIFY

See Also:

Constant Field Values

Constructor Detail

ScanService

public ScanService(ApiManager api)

Parameters:

api - ApiManager instance

Method Detail

recognitionsCreator

public EvrythngApiBuilder.Builder<UrlBinding> recognitionsCreator(UrlBinding imageInBinding,
                                                                  ScanService.ScanMethod... methods)
                                                           throws EvrythngException

POST "/scan/recognitions"

Scan a Base64 image. Return the corresponding binding in

Parameters:

imageInBinding - image UrlBinding instance

methods - array of ScanService.ScanMethod

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngException

recognitionsCreator

public EvrythngApiBuilder.Builder<UrlBinding> recognitionsCreator(String base64Image,
                                                                  ScanService.ScanMethod... methods)
                                                           throws EvrythngException

POST "/scan/recognitions"

Parameters:

base64Image - base64 encoded image, with mime type header.

methods - array of ScanService.ScanMethod

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngException

identifyCreator

public EvrythngApiBuilder.Builder<UrlBinding> identifyCreator(String base64Image)
                                                       throws EvrythngException

POST "/identify"

Scan a Base64 image. Return the corresponding binding in

Parameters:

base64Image - base64 encoded image, with mime type header.

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngException

identifyCreator

public EvrythngApiBuilder.Builder<UrlBinding> identifyCreator(String base64Image,
                                                              ScanService.IdentifyType type)
                                                       throws EvrythngException

POST "/identify"

Identify a Base64 image. Return the corresponding bindings

Parameters:

base64Image - base64 encoded image, with mime type header.

type - one available ScanService.IdentifyType

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngException

identifyCreator

public EvrythngApiBuilder.Builder<UrlBinding> identifyCreator(InputStream image,
                                                              String mime,
                                                              ScanService.IdentifyType type)
                                                       throws EvrythngException,
                                                              IOException

POST "/identify"

Identify an image. Return the corresponding bindings

Parameters:

image - Image as an input stream.

mime - mime type

type - one available ScanService.IdentifyType

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngException

IOException

identifyCreator

public EvrythngApiBuilder.Builder<UrlBinding> identifyCreator(UrlBinding imageInBinding)
                                                       throws EvrythngException

POST "/identify"

Identify an image. Return the corresponding bindings

Parameters:

imageInBinding - image UrlBinding instance

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngException

identifyCreator

public EvrythngApiBuilder.Builder<UrlBinding> identifyCreator(UrlBinding imageInBinding,
                                                              ScanService.IdentifyType type)
                                                       throws EvrythngException

POST "/identify"

Identify an image. Return the corresponding bindings

Parameters:

imageInBinding - image UrlBinding instance

type - one available ScanService.IdentifyType

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngException

recognitionsCreator

public EvrythngApiBuilder.Builder<UrlBinding> recognitionsCreator(InputStream image,
                                                                  String mime,
                                                                  ScanService.ScanMethod... methods)
                                                           throws EvrythngException,
                                                                  IOException

POST "/scan/recognitions"

Parameters:

image - image input stream. The input stream is quietly closed after call of this method.

mime - MIME type

methods - array of ScanService.ScanMethod

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngException

IOException

scanBarcodeCreator

public EvrythngApiBuilder.Builder<UrlBinding> scanBarcodeCreator(UrlBinding scanBarcodeData)
                                                          throws EvrythngException

POST "/scan/barcode"

Scan a barcode. Return the corresponding binding in

Parameters:

scanBarcodeData - bar code UrlBinding

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngException