com.hpe.caf.worker.languagedetection

Class LanguageDetectionUtilities

java.lang.Object

com.hpe.caf.worker.languagedetection.LanguageDetectionUtilities

public final class LanguageDetectionUtilities
extends Object

Method Summary

Modifier and Type	Method and Description
static void	addDetectedLanguagesToDocument(LanguageDetectorResult detectorResult, com.hpe.caf.worker.document.model.Document document)
static void	addDetectedLanguagesToDocument(LanguageDetectorResult detectorResult, com.hpe.caf.worker.document.model.Document document, String fieldName)
static void	addDetectedLanguageToDocument(LanguageDetectorResult detectorResult, com.hpe.caf.worker.document.model.Document document, com.hpe.caf.worker.document.model.Field sourceDataField, LanguageDetectionResultFormat resultFormat, boolean inMultiFieldMode) Updates the passed document with the language detection result passed in detectorResult.
static SequenceInputStream	getFieldValuesAsStreams(com.hpe.caf.worker.document.model.Field sourceDataField)
static void	outputDocumentFieldValueChanges(com.hpe.caf.worker.document.model.Document document)

Methods inherited from class java.lang.Object

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

Method Detail

getFieldValuesAsStreams

public static SequenceInputStream getFieldValuesAsStreams(com.hpe.caf.worker.document.model.Field sourceDataField)
                                                   throws RuntimeException

Throws:

RuntimeException

addDetectedLanguagesToDocument

public static void addDetectedLanguagesToDocument(LanguageDetectorResult detectorResult,
                                                  com.hpe.caf.worker.document.model.Document document)

addDetectedLanguagesToDocument

public static void addDetectedLanguagesToDocument(LanguageDetectorResult detectorResult,
                                                  com.hpe.caf.worker.document.model.Document document,
                                                  String fieldName)

outputDocumentFieldValueChanges

public static void outputDocumentFieldValueChanges(com.hpe.caf.worker.document.model.Document document)

addDetectedLanguageToDocument

public static void addDetectedLanguageToDocument(LanguageDetectorResult detectorResult,
                                                 com.hpe.caf.worker.document.model.Document document,
                                                 com.hpe.caf.worker.document.model.Field sourceDataField,
                                                 LanguageDetectionResultFormat resultFormat,
                                                 boolean inMultiFieldMode)
                                          throws RuntimeException

Updates the passed document with the language detection result passed in detectorResult.

Parameters:

detectorResult - result of performing language detection. Cannot be null.

document - the document to update with result of language detection. Cannot be null.

sourceDataField - the field that language detection was ran against. Depending on the values of resultFormat and inMultiFieldMode this may be used in the output field name. Cannot be null.

resultFormat - whether the result fields should be output in simple or complex format. If set to COMPLEX then inMultiFieldMode has no effect on output fields. Cannot be null.

inMultiFieldMode - whether the language detection was ran in multi-field mode. This will effect the fields output but only if resultFormat is set to LanguageDetectionResultFormat.SIMPLE.

Throws:

RuntimeException - if detectorResult, document or sourceDataField is null.