org.imixs.ml.service

Class TikaHelperService

java.lang.Object

org.imixs.ml.service.TikaHelperService

public class TikaHelperService
extends Object

This class is a helper class to extrect text content form attached documents. The service loades the corresponding snapthsot for a workitem. It is used only by the TrainingService. org.imixs.archive.documents.TikaService See also the project: https://github.com/imixs/imixs-archive

Version:

1.1

Author:

rsoika

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ENCODING
static String	ENV_OCR_SERVICE_ENDPOINT
static String	ENV_OCR_SERVICE_MODE
static String	ENV_OCR_STRATEGY
static String	OCR_STRATEGY_AUTO
static String	OCR_STRATEGY_NO_OCR
static String	OCR_STRATEGY_OCR_AND_TEXT_EXTRACTION
static String	OCR_STRATEGY_OCR_ONLY
static String	PLUGIN_ERROR

Constructor Summary

Constructors

Constructor and Description
TikaHelperService()

Method Summary

Modifier and Type	Method and Description
String	doORCProcessing(org.imixs.workflow.FileData fileData, List<String> options) This method sends the content of a document to the Tika Rest API for OCR processing.
String	extractText(org.imixs.workflow.ItemCollection snapshot, Pattern mlFilenamePattern, String _ocrStategy, List<String> options) Extracts the textual information from document attachments.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ENCODING

public static final String DEFAULT_ENCODING

See Also:

Constant Field Values

PLUGIN_ERROR

public static final String PLUGIN_ERROR

See Also:

Constant Field Values

ENV_OCR_SERVICE_ENDPOINT

public static final String ENV_OCR_SERVICE_ENDPOINT

See Also:

Constant Field Values

ENV_OCR_SERVICE_MODE

public static final String ENV_OCR_SERVICE_MODE

See Also:

Constant Field Values

ENV_OCR_STRATEGY

public static final String ENV_OCR_STRATEGY

See Also:

Constant Field Values

OCR_STRATEGY_NO_OCR

public static final String OCR_STRATEGY_NO_OCR

See Also:

Constant Field Values

OCR_STRATEGY_OCR_AND_TEXT_EXTRACTION

public static final String OCR_STRATEGY_OCR_AND_TEXT_EXTRACTION

See Also:

Constant Field Values

OCR_STRATEGY_OCR_ONLY

public static final String OCR_STRATEGY_OCR_ONLY

See Also:

Constant Field Values

OCR_STRATEGY_AUTO

public static final String OCR_STRATEGY_AUTO

See Also:

Constant Field Values

Constructor Detail

TikaHelperService

public TikaHelperService()

Method Detail

extractText

public String extractText(org.imixs.workflow.ItemCollection snapshot,
                          Pattern mlFilenamePattern,
                          String _ocrStategy,
                          List<String> options)
                   throws org.imixs.workflow.exceptions.PluginException

Extracts the textual information from document attachments.

The method extracts the textual content for each new file attachment of a given workitem. The text information is stored in the $file attribute 'text'.

For PDF files with textual content the method calls the method 'extractTextFromPDF' using the PDFBox api. In other cases, the method sends the content via a Rest API to the tika server for OCR processing.

The method also extracts files already stored in a snapshot workitem. In this case the method tests if the $file attribute 'text' already exists.

Parameters:

workitem - - workitem with file attachments

pdf_mode - - TEXT_ONLY, OCR_ONLY, TEXT_AND_OCR

options - - optional tika header params

Throws:

org.imixs.workflow.exceptions.PluginException

doORCProcessing

public String doORCProcessing(org.imixs.workflow.FileData fileData,
                              List<String> options)
                       throws IOException

This method sends the content of a document to the Tika Rest API for OCR processing.

In case the contentType is PDF then the following tika specific header is added:

X-Tika-PDFOcrStrategy: ocr_only

Parameters:

fileData - - file content and metadata

Returns:

text content

Throws:

IOException