Package org.apache.tika.language.detect

Class LanguageResult

java.lang.Object

org.apache.tika.language.detect.LanguageResult

public class LanguageResult
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final LanguageResult	NULL

Constructor Summary

Constructors

Constructor	Description
LanguageResult(String language, LanguageConfidence confidence, float rawScore)
LanguageResult(String language, LanguageConfidence confidence, float rawScore, float confidenceScore)

Method Summary

Modifier and Type	Method	Description
LanguageConfidence	getConfidence()
float	getConfidenceScore()	Detector-agnostic confidence score (0.0 to 1.0).
String	getLanguage()	The ISO 639-1 language code (plus optional country code)
float	getRawScore()
boolean	isLanguage(String language)	Return true if the target language matches the detected language.
boolean	isReasonablyCertain()
boolean	isUnknown()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

NULL

public static final LanguageResult NULL

Constructor Details

LanguageResult

public LanguageResult(String language,
 LanguageConfidence confidence,
 float rawScore)

Parameters:

language - ISO 639-1 language code (plus optional country code)

rawScore - confidence of detector in the result.

LanguageResult

public LanguageResult(String language,
 LanguageConfidence confidence,
 float rawScore,
 float confidenceScore)

Parameters:

language - ISO 639-1 language code (plus optional country code)

rawScore - detector-specific score (e.g., softmax probability)

confidenceScore - detector-agnostic confidence (0.0 to 1.0, higher = more confident). For comparing results across different decodings or detectors.

Method Details

getLanguage

public String getLanguage()

The ISO 639-1 language code (plus optional country code)

Returns:

a string representation of the language code

getRawScore

public float getRawScore()

getConfidenceScore

public float getConfidenceScore()

Detector-agnostic confidence score (0.0 to 1.0). Higher values indicate the detector is more confident in the result. This can be used to compare results across different text decodings (e.g., for encoding detection) without knowing the detector implementation.

getConfidence

public LanguageConfidence getConfidence()

isReasonablyCertain

public boolean isReasonablyCertain()

isUnknown

public boolean isUnknown()

isLanguage

public boolean isLanguage(String language)

Return true if the target language matches the detected language. We consider it a match if, for the precision requested or detected, it matches. This means:

target | detected | match? zh | en | false zh | zh | true zh | zh-CN | true zh-CN | zh | true zh-CN | zh-TW | false zh-CN | zh-cn | true (case-insensitive)

Parameters:

language -

Returns:

toString

public String toString()

Overrides:

toString in class Object