Package com.openkm.sdk4j.impl

Class OcrImpl

java.lang.Object

com.openkm.sdk4j.impl.ClientImpl

com.openkm.sdk4j.impl.OcrImpl

All Implemented Interfaces:

BaseOcr, Serializable

public class OcrImpl
extends ClientImpl
implements BaseOcr

OcrImpl

Author:

sochoa

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
OcrImpl(String host)	OcrImpl

Method Summary

Modifier and Type	Method	Description
OCRTemplate	create(String name, String mimeType, boolean active, InputStream is, Map<String,String> properties)
void	createControlField(long templateId, String name, String className, String pattern, String value, int rotation, String custom, String ocr, int order, boolean emptyAllowed, int x1, int y1, int x2, int y2)
void	createField(long templateId, String name, String className, String propertyGroupName, String pattern, int rotation, String custom, String ocr, boolean control, int x1, int y1, int x2, int y2)
void	delete(long templateId)
void	deleteControlField(long templateId, long controlFieldId)
void	deleteField(long templateId, long fieldId)
OCRTemplateControlField	getControlField(long controlFieldId)
InputStream	getCroppedImageControlField(long templateId, long controlFieldId)
InputStream	getCroppedImageField(long templateId, long fieldId)
OCRTemplateField	getField(long fieldId)
InputStream	getImage(long templateId)
OCRTemplate	getTemplate(long templateId)
List<OCRTemplate>	getTemplates(boolean showAll)
OCRTemplateResultSet	getTemplates(String filter, int offset, int limit)
boolean	hasOCRDataCapture()
void	setAuthorizationToken(String authorizationToken)	setAuthenticationToken
OCRTemplate	update(long templateId, String name, String mimeType, boolean active, InputStream is, Map<String,String> properties)
void	updateControlField(long templateId, long controlFieldId, String name, String className, String pattern, String value, int rotation, String custom, String ocr, int order, boolean emptyAllowed, int x1, int y1, int x2, int y2)
void	updateField(long templateId, long fieldId, String name, String className, String propertyGroupName, String pattern, int rotation, String custom, String ocr, boolean control, int x1, int y1, int x2, int y2)

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl

getClient, getWebTarget, setAuthorizationHeader, setJsessionIdHeader

Methods inherited from class java.lang.Object

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

Constructor Detail

OcrImpl

public OcrImpl(String host)

OcrImpl

Method Detail

setAuthorizationToken

public void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

create

public OCRTemplate create(String name,
                          String mimeType,
                          boolean active,
                          InputStream is,
                          Map<String,String> properties)
                   throws DatabaseException,
                          OCRTemplateException,
                          AccessDeniedException,
                          UnknownException,
                          WebserviceException

Specified by:

create in interface BaseOcr

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

update

public OCRTemplate update(long templateId,
                          String name,
                          String mimeType,
                          boolean active,
                          InputStream is,
                          Map<String,String> properties)
                   throws DatabaseException,
                          OCRTemplateException,
                          AccessDeniedException,
                          UnknownException,
                          WebserviceException

Specified by:

update in interface BaseOcr

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

delete

public void delete(long templateId)
            throws DatabaseException,
                   OCRTemplateException,
                   AccessDeniedException,
                   UnknownException,
                   WebserviceException

Specified by:

delete in interface BaseOcr

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

getTemplate

public OCRTemplate getTemplate(long templateId)
                        throws DatabaseException,
                               OCRTemplateException,
                               AccessDeniedException,
                               UnknownException,
                               WebserviceException

Specified by:

getTemplate in interface BaseOcr

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

createField

public void createField(long templateId,
                        String name,
                        String className,
                        String propertyGroupName,
                        String pattern,
                        int rotation,
                        String custom,
                        String ocr,
                        boolean control,
                        int x1,
                        int y1,
                        int x2,
                        int y2)
                 throws DatabaseException,
                        OCRTemplateException,
                        AccessDeniedException,
                        UnknownException,
                        WebserviceException

Specified by:

createField in interface BaseOcr

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

updateField

public void updateField(long templateId,
                        long fieldId,
                        String name,
                        String className,
                        String propertyGroupName,
                        String pattern,
                        int rotation,
                        String custom,
                        String ocr,
                        boolean control,
                        int x1,
                        int y1,
                        int x2,
                        int y2)
                 throws DatabaseException,
                        OCRTemplateException,
                        AccessDeniedException,
                        UnknownException,
                        WebserviceException

Specified by:

updateField in interface BaseOcr

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

deleteField

public void deleteField(long templateId,
                        long fieldId)
                 throws DatabaseException,
                        OCRTemplateException,
                        AccessDeniedException,
                        UnknownException,
                        WebserviceException

Specified by:

deleteField in interface BaseOcr

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

getField

public OCRTemplateField getField(long fieldId)
                          throws DatabaseException,
                                 OCRTemplateException,
                                 AccessDeniedException,
                                 UnknownException,
                                 WebserviceException

Specified by:

getField in interface BaseOcr

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

createControlField

public void createControlField(long templateId,
                               String name,
                               String className,
                               String pattern,
                               String value,
                               int rotation,
                               String custom,
                               String ocr,
                               int order,
                               boolean emptyAllowed,
                               int x1,
                               int y1,
                               int x2,
                               int y2)
                        throws DatabaseException,
                               OCRTemplateException,
                               AccessDeniedException,
                               UnknownException,
                               WebserviceException

Specified by:

createControlField in interface BaseOcr

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

updateControlField

public void updateControlField(long templateId,
                               long controlFieldId,
                               String name,
                               String className,
                               String pattern,
                               String value,
                               int rotation,
                               String custom,
                               String ocr,
                               int order,
                               boolean emptyAllowed,
                               int x1,
                               int y1,
                               int x2,
                               int y2)
                        throws DatabaseException,
                               OCRTemplateException,
                               AccessDeniedException,
                               UnknownException,
                               WebserviceException

Specified by:

updateControlField in interface BaseOcr

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

deleteControlField

public void deleteControlField(long templateId,
                               long controlFieldId)
                        throws DatabaseException,
                               OCRTemplateException,
                               AccessDeniedException,
                               UnknownException,
                               WebserviceException

Specified by:

deleteControlField in interface BaseOcr

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

getControlField

public OCRTemplateControlField getControlField(long controlFieldId)
                                        throws DatabaseException,
                                               OCRTemplateException,
                                               AccessDeniedException,
                                               UnknownException,
                                               WebserviceException

Specified by:

getControlField in interface BaseOcr

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

getTemplates

public List<OCRTemplate> getTemplates(boolean showAll)
                               throws DatabaseException,
                                      OCRTemplateException,
                                      AccessDeniedException,
                                      UnknownException,
                                      WebserviceException

Specified by:

getTemplates in interface BaseOcr

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

getTemplates

public OCRTemplateResultSet getTemplates(String filter,
                                         int offset,
                                         int limit)
                                  throws DatabaseException,
                                         OCRTemplateException,
                                         AccessDeniedException,
                                         UnknownException,
                                         WebserviceException

Specified by:

getTemplates in interface BaseOcr

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

getImage

public InputStream getImage(long templateId)
                     throws DatabaseException,
                            OCRTemplateException,
                            AccessDeniedException,
                            UnknownException,
                            WebserviceException

Specified by:

getImage in interface BaseOcr

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

getCroppedImageField

public InputStream getCroppedImageField(long templateId,
                                        long fieldId)
                                 throws DatabaseException,
                                        OCRTemplateException,
                                        AccessDeniedException,
                                        UnknownException,
                                        WebserviceException

Specified by:

getCroppedImageField in interface BaseOcr

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

getCroppedImageControlField

public InputStream getCroppedImageControlField(long templateId,
                                               long controlFieldId)
                                        throws DatabaseException,
                                               OCRTemplateException,
                                               AccessDeniedException,
                                               UnknownException,
                                               WebserviceException

Specified by:

getCroppedImageControlField in interface BaseOcr

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

hasOCRDataCapture

public boolean hasOCRDataCapture()
                          throws DatabaseException,
                                 OCRTemplateException,
                                 AccessDeniedException,
                                 UnknownException,
                                 WebserviceException

Specified by:

hasOCRDataCapture in interface BaseOcr

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException