com.basistech.rosette.apimodel

Class LanguageOptions

java.lang.Object

com.basistech.rosette.apimodel.LanguageOptions

public final class LanguageOptions
extends Object

Languages detection options

Constructor Summary

Constructors

Constructor and Description
LanguageOptions() Create a set of language detection options with default values.
LanguageOptions(Integer minValidChars, Integer profileDepth, Double ambiguityThreshold, Double invalidityThreshold, com.basistech.util.LanguageCode languageHint, Double languageHintWeight, com.basistech.rosette.util.EncodingCode encodingHint, Double encodingHintWeight, Set<LanguageWeight> languageWeightAdjustments) constructor for LanguageOptions

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) if the param is a LanguageOptions, compare contents for equality
Double	getAmbiguityThreshold() get the n-gram distance ambiguity threshold, value range [0-100].
com.basistech.rosette.util.EncodingCode	getEncodingHint() get encoding hint used to help resolve ambiguous results
Double	getEncodingHintWeight() get the encoding hint weight used to help resolve ambiguous results, value range [1-100].
Double	getInvalidityThreshold() get the n-gram distance invalidity threshold, value range [0-100].
com.basistech.util.LanguageCode	getLanguageHint() get the language hint
Double	getLanguageHintWeight() get the language hint weight used to help resolve ambiguous results.
Set<LanguageWeight>	getLanguageWeightAdjustments() get the set of language weight adjustments
Integer	getMinValidChars() get minimum number of valid characters needed for identification
Integer	getProfileDepth() get the most frequent n-grams to consider in detection.
int	hashCode()
void	setAmbiguityThreshold(Double ambiguityThreshold) set the n-gram distance ambiguity threshold, value range [0-100].
void	setEncodingHint(com.basistech.rosette.util.EncodingCode encodingHint) set encoding hint used to help resolve ambiguous results
void	setEncodingHintWeight(double encodingHintWeight) set the encoding hint weight used to help resolve ambiguous results, value range [1-100].
void	setInvalidityThreshold(Double invalidityThreshold) get the n-gram distance invalidity threshold, value range [0-100].
void	setLanguageHint(com.basistech.util.LanguageCode languageHint) set the language hint
void	setLanguageHintWeight(double languageHintWeight) set the language hint weight used to help resolve ambiguous results.
void	setLanguageWeightAdjustments(Set<LanguageWeight> languageWeightAdjustments) set the set of language weight adjustments
void	setMinValidChars(Integer minValidChars) set minimum number of valid characters needed for identification
void	setProfileDepth(Integer profileDepth) set the most frequent n-grams to consider in detection.

Methods inherited from class java.lang.Object

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

Constructor Detail

LanguageOptions

public LanguageOptions()

Create a set of language detection options with default values. Note that null is used to represent defaults.

LanguageOptions

public LanguageOptions(Integer minValidChars,
                       Integer profileDepth,
                       Double ambiguityThreshold,
                       Double invalidityThreshold,
                       com.basistech.util.LanguageCode languageHint,
                       Double languageHintWeight,
                       com.basistech.rosette.util.EncodingCode encodingHint,
                       Double encodingHintWeight,
                       Set<LanguageWeight> languageWeightAdjustments)

constructor for LanguageOptions

Parameters:

minValidChars - minimum number of valid characters required for identification

profileDepth - number of n-grams to consider in detection

ambiguityThreshold - number of n-gram distance ambiguity threshold

invalidityThreshold - number of n-gram distance invalidity threshold

languageHint - language hint used to resolve ambiguous results

languageHintWeight - language hint weight used to resolve ambiguous results

encodingHint - encoding hint used to resolve ambiguous results

encodingHintWeight - encoding hint weight used to resolve ambiguous results

languageWeightAdjustments - language weight adjustment

Method Detail

getMinValidChars

public Integer getMinValidChars()

get minimum number of valid characters needed for identification

Returns:

minimum number of valid characters

getProfileDepth

public Integer getProfileDepth()

get the most frequent n-grams to consider in detection. + Smaller depth results in faster operation but lower detection accuracy.

Returns:

number of n-grams

getAmbiguityThreshold

public Double getAmbiguityThreshold()

get the n-gram distance ambiguity threshold, value range [0-100]. + Input profile distances closer to each other than this threshold are deemed ambiguous.

Returns:

number of n-gram distance ambiguity threshold

getInvalidityThreshold

public Double getInvalidityThreshold()

get the n-gram distance invalidity threshold, value range [0-100]. Input profile distance exceeding this threshold will be deemed invalid .

Returns:

number of n-gram distance invalidity threshold

getLanguageHint

public com.basistech.util.LanguageCode getLanguageHint()

get the language hint

Returns:

language hint

getLanguageHintWeight

public Double getLanguageHintWeight()

get the language hint weight used to help resolve ambiguous results. + A value of N reduces the distance of correctly hinted ambiguous result by N%. + Weight Value range [1-99]. Value of 1 is the lightest hint, value of 99 the strongest.

Returns:

the language hint weight

getEncodingHint

public com.basistech.rosette.util.EncodingCode getEncodingHint()

get encoding hint used to help resolve ambiguous results

Returns:

the encoding hint

getEncodingHintWeight

public Double getEncodingHintWeight()

get the encoding hint weight used to help resolve ambiguous results, value range [1-100]. + A value of N reduces the distance of correctly hinted result by N%. + A value of 1 is the lightest hint. + A value of 100 forces the detector to consider only the results with the hinted encoding.

Returns:

the encoding hint weight

getLanguageWeightAdjustments

public Set<LanguageWeight> getLanguageWeightAdjustments()

get the set of language weight adjustments

Returns:

the set of language weight adjustments

setMinValidChars

public void setMinValidChars(Integer minValidChars)

set minimum number of valid characters needed for identification

Parameters:

minValidChars - minimum number of valid characters

setProfileDepth

public void setProfileDepth(Integer profileDepth)

set the most frequent n-grams to consider in detection. + Smaller depth results in faster operation but lower detection accuracy.

Parameters:

profileDepth - number of n-grams

setAmbiguityThreshold

public void setAmbiguityThreshold(Double ambiguityThreshold)

set the n-gram distance ambiguity threshold, value range [0-100]. + Input profile distances closer to each other than this threshold are deemed ambiguous.

Parameters:

ambiguityThreshold - number of n-grams distance ambiguity threshold

setInvalidityThreshold

public void setInvalidityThreshold(Double invalidityThreshold)

get the n-gram distance invalidity threshold, value range [0-100]. Input profile distance exceeding this threshold will be deemed invalid.

Parameters:

invalidityThreshold - number of n-grams distance invalidity threshold

setLanguageHint

public void setLanguageHint(com.basistech.util.LanguageCode languageHint)

set the language hint

Parameters:

languageHint - the language hint

setLanguageHintWeight

public void setLanguageHintWeight(double languageHintWeight)

set the language hint weight used to help resolve ambiguous results. + A value of N reduces the distance of correctly hinted ambiguous result by N%. + Weight Value range [1-99]. Value of 1 is the lightest hint, value of 99 the strongest.

Parameters:

languageHintWeight - hint weight.

setEncodingHint

public void setEncodingHint(com.basistech.rosette.util.EncodingCode encodingHint)

set encoding hint used to help resolve ambiguous results

Parameters:

encodingHint - the encoding hint

setEncodingHintWeight

public void setEncodingHintWeight(double encodingHintWeight)

set the encoding hint weight used to help resolve ambiguous results, value range [1-100]. + A value of N reduces the distance of correctly hinted result by N%. + A value of 1 is the lightest hint. + A value of 100 forces the detector to consider only the results with the hinted encoding.

Parameters:

encodingHintWeight - the encoding hint weight

setLanguageWeightAdjustments

public void setLanguageWeightAdjustments(Set<LanguageWeight> languageWeightAdjustments)

set the set of language weight adjustments

Parameters:

languageWeightAdjustments - the set of language weight adjustments

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

if the param is a LanguageOptions, compare contents for equality

Overrides:

equals in class Object

Parameters:

o - the object

Returns:

whether or not the param object is equal to this object