com.openkm.sdk4j.definition

Interface BaseConversion

All Known Implementing Classes:

ConversionImpl

public interface BaseConversion

BaseConversion

Author:

jllort

Method Summary

Modifier and Type	Method and Description
String	barcode2txt(InputStream is, String fileName) Extracts the barcode text from the uploaded image.
InputStream	doc2pdf(InputStream is, String fileName) Retrieve the uploaded document converted to PDF format.
String	doc2txt(InputStream is, String fileName) Extracts the text from the upload document.
InputStream	html2pdf(String url) Retrieve the PDF of an URL.
InputStream	imageConvert(InputStream is, String fileName, String params, String dstMimeType) Retrieve the uploaded image with transformation.
String	img2txt(InputStream is, String fileName) Extracts the text from the uploaded image.

Method Detail

doc2pdf

InputStream doc2pdf(InputStream is,
                    String fileName)
             throws org.apache.commons.lang.NotImplementedException,
                    ConversionException,
                    WebserviceException,
                    UnknownException

Retrieve the uploaded document converted to PDF format.

Parameters:

is - The content of the file

fileName - the file name

Returns:

InputStream input stream

Throws:

org.apache.commons.lang.NotImplementedException - the not implemented exception

ConversionException - the conversion exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

imageConvert

InputStream imageConvert(InputStream is,
                         String fileName,
                         String params,
                         String dstMimeType)
                  throws WebserviceException,
                         UnknownException

Retrieve the uploaded image with transformation.

Parameters:

is - The content of the file

fileName - the file name

params - the params

dstMimeType - the dst mime type

Returns:

InputStream input stream

Throws:

WebserviceException - the webservice exception

UnknownException - the unknown exception

html2pdf

InputStream html2pdf(String url)
              throws ConversionException,
                     WebserviceException,
                     UnknownException

Retrieve the PDF of an URL.

Parameters:

url - the url

Returns:

InputStream input stream

Throws:

ConversionException - the conversion exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

doc2txt

String doc2txt(InputStream is,
               String fileName)
        throws WebserviceException,
               UnknownException

Extracts the text from the upload document.

Parameters:

is - The content of the file

fileName - the file name

Returns:

String string

Throws:

WebserviceException - the webservice exception

UnknownException - the unknown exception

img2txt

String img2txt(InputStream is,
               String fileName)
        throws WebserviceException,
               UnknownException

Extracts the text from the uploaded image.

Parameters:

is - The content of the file

fileName - The filename

Returns:

String string

Throws:

WebserviceException - the webservice exception

UnknownException - the unknown exception

barcode2txt

String barcode2txt(InputStream is,
                   String fileName)
            throws WebserviceException,
                   UnknownException

Extracts the barcode text from the uploaded image.

Parameters:

is - The content of the file

fileName - the file name

Returns:

String string

Throws:

WebserviceException - the webservice exception

UnknownException - the unknown exception