Package com.openkm.sdk4j.definition

Interface BaseOcr

All Known Implementing Classes:

OcrImpl

public interface BaseOcr

BaseOcr

Author:

sochoa

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

Method Detail

create

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

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

update

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

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

delete

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

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

getTemplate

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

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

createField

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

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

updateField

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

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

deleteField

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

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

getField

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

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

createControlField

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

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

updateControlField

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

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

deleteControlField

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

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

getControlField

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

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

getTemplates

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

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

getTemplates

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

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

getImage

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

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

getCroppedImageField

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

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

getCroppedImageControlField

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

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException

hasOCRDataCapture

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

Throws:

DatabaseException

OCRTemplateException

AccessDeniedException

UnknownException

WebserviceException