org.jahia.services.textextraction

Class TextExtractionHelper

java.lang.Object

org.jahia.services.textextraction.TextExtractionHelper

public final class TextExtractionHelper
extends Object

Text extraction utility class for (re-)extracting text on existing document nodes.

Author:

Benjamin Papez

Method Summary

Modifier and Type	Method and Description
static ExtractionCheckStatus	checkExtractionByFilter(boolean redoExtraction, RepositoryFileFilter filter, Writer statusOut) Triggers the process of checking for files (by filter), where extraction is possible.
static ExtractionCheckStatus	checkMissingExtraction(boolean fixMissingExtraction, Writer statusOut) Triggers the process of checking for missing text extractions check.
static void	forceStopExtractionCheck() Forces stop of the extraction check process if it is currently running.
static boolean	isCheckingExtractions() Returns true if the process for checking extractions is currently running.

Methods inherited from class java.lang.Object

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

Method Detail

checkMissingExtraction

public static ExtractionCheckStatus checkMissingExtraction(boolean fixMissingExtraction,
                                                           Writer statusOut)
                                                    throws javax.jcr.RepositoryException

Triggers the process of checking for missing text extractions check. If the fixMissingExtraction is set to true also tries to extract the text now. This method ensures that only one check process runs at a time.

Parameters:

fixMissingExtraction - if set to true performs the text extraction now; in case of false only the missing extraction count is reported, but no fix is done

statusOut - a writer to log current processing status into

Returns:

the status object to indicate the result of the check

Throws:

javax.jcr.RepositoryException - in case of JCR errors

checkExtractionByFilter

public static ExtractionCheckStatus checkExtractionByFilter(boolean redoExtraction,
                                                            RepositoryFileFilter filter,
                                                            Writer statusOut)
                                                     throws javax.jcr.RepositoryException

Triggers the process of checking for files (by filter), where extraction is possible. If the redoExtraction is set to true also tries to extract the text now. This method ensures that only one check process runs at a time.

Parameters:

redoExtraction - if set to true performs the text extraction now; in case of false only the extraction count is reported, but not redone

statusOut - a writer to log current processing status into

Returns:

the status object to indicate the result of the check

Throws:

javax.jcr.RepositoryException - in case of JCR errors

forceStopExtractionCheck

public static void forceStopExtractionCheck()

Forces stop of the extraction check process if it is currently running.

isCheckingExtractions

public static boolean isCheckingExtractions()

Returns true if the process for checking extractions is currently running.

Returns:

true if the process for checking extractions is currently running; false otherwise