org.apache.tika.language.detect

Class LanguageResult

java.lang.Object

org.apache.tika.language.detect.LanguageResult

public class LanguageResult
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
private LanguageConfidence	confidence
private java.lang.String	language
static LanguageResult	NULL
private float	rawScore

Constructor Summary

Constructors

Constructor and Description
LanguageResult(java.lang.String language, LanguageConfidence confidence, float rawScore)

Method Summary

Modifier and Type	Method and Description
LanguageConfidence	getConfidence()
java.lang.String	getLanguage() The ISO 639-1 language code (plus optional country code)
float	getRawScore()
boolean	isLanguage(java.lang.String language) Return true if the target language matches the detected language.
boolean	isReasonablyCertain()
boolean	isUnknown()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NULL

public static final LanguageResult NULL

language

private java.lang.String language

confidence

private LanguageConfidence confidence

rawScore

private float rawScore

Constructor Detail

LanguageResult

public LanguageResult(java.lang.String language,
                      LanguageConfidence confidence,
                      float rawScore)

Parameters:

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

rawScore - confidence of detector in the result.

Method Detail

getLanguage

public java.lang.String getLanguage()

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

Returns:

a string representation of the language code

getRawScore

public float getRawScore()

getConfidence

public LanguageConfidence getConfidence()

isReasonablyCertain

public boolean isReasonablyCertain()

isUnknown

public boolean isUnknown()

isLanguage

public boolean isLanguage(java.lang.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 java.lang.String toString()

Overrides:

toString in class java.lang.Object