microsoft.hawaii.sdk.OcrService.ServiceAgents

Class OcrAgent

java.lang.Object

microsoft.hawaii.hawaiiClientLibraryBase.ServiceAgent<OcrServiceResult>

microsoft.hawaii.sdk.OcrService.ServiceAgents.OcrAgent

public class OcrAgent
extends ServiceAgent<OcrServiceResult>

This class provides helper methods used to communicate with the Hawaii OCR Service. for character recognition. This class accepts an image buffer as an input, sends it to the OCR service and receives the result of the OCR processing.

Field Summary

Fields inherited from class microsoft.hawaii.hawaiiClientLibraryBase.ServiceAgent

clientIdentity, httpMethod, onCompleteListener, serviceResult, serviceResultClass, serviceUri

Constructor Summary

Constructors

Constructor and Description
OcrAgent(java.net.URI baseUri, ClientIdentity clientIdentity, byte[] imageBuffer, java.lang.Object state) Initializes an instance of the OcrAgent class

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getContentType() Override getContentType method of ServiceAgent class
byte[]	getImageBuffer() Gets the buffer containing the image
protected byte[]	getRequestBodyData() Override getRequestBodyData method of ServiceAgent class
protected void	OnCompleteRequest() Override OnCompleteRequest of ServiceAgent class

Methods inherited from class microsoft.hawaii.hawaiiClientLibraryBase.ServiceAgent

constructHttpRequest, getServiceResult, handleException, handleException, parseOutput, parseServiceResultRequired, processRequest, setServiceResult

Methods inherited from class java.lang.Object

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

Constructor Detail

OcrAgent

public OcrAgent(java.net.URI baseUri,
        ClientIdentity clientIdentity,
        byte[] imageBuffer,
        java.lang.Object state)
         throws java.lang.Exception

Initializes an instance of the OcrAgent class

Parameters:

baseUri - URI to access service

clientIdentity - the client identity

imageBuffer - Request image bytes

state - specifies a user-defined object

Throws:

java.lang.Exception

Method Detail

getImageBuffer

public byte[] getImageBuffer()

Gets the buffer containing the image

Returns:

the image buffer

getContentType

public java.lang.String getContentType()

Override getContentType method of ServiceAgent class

Overrides:

getContentType in class ServiceAgent<OcrServiceResult>

Returns:

String content type

getRequestBodyData

protected byte[] getRequestBodyData()
                             throws HawaiiException

Override getRequestBodyData method of ServiceAgent class

Overrides:

getRequestBodyData in class ServiceAgent<OcrServiceResult>

Returns:

Throws:

HawaiiException - byte[]

OnCompleteRequest

protected void OnCompleteRequest()

Override OnCompleteRequest of ServiceAgent class

Overrides:

OnCompleteRequest in class ServiceAgent<OcrServiceResult>