com.cybozu.labs.langdetect

Class DetectorFactory

java.lang.Object

com.cybozu.labs.langdetect.DetectorFactory

All Implemented Interfaces:

java.io.Serializable

public class DetectorFactory
extends java.lang.Object
implements java.io.Serializable

Language Detector Factory Class WARNING: HIGHLY MUTABLE CLASS. USE CAUTION IN CONCURRENT and DISTRIBUTED USE CASES! This class manages an initialization and constructions of Detector. Before using language detection library, load profiles with loadProfile(String) method and set initialization parameters. When the language detection, construct Detector instance via create(). See also Detector's sample code.

• 4x faster improvement based on Elmer Garduno's code. Thanks!

See Also:

Detector, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DetectorFactory()
DetectorFactory(java.util.Map<java.lang.String,double[]> wordLangProbMap, java.util.ArrayList<java.lang.String> langlist, long seed)

Method Summary

Modifier and Type	Method and Description
void	addProfile(LangProfile profile, int index, int langsize)
void	clear() Clear loaded language profiles (reinitialization to be available)
Detector	create() Construct Detector instance
Detector	create(double alpha) Construct Detector instance with smoothing parameter
java.util.List<java.lang.String>	getLangList() The languages that this detector factory knows about.
long	getSeed()
java.util.Map<java.lang.String,double[]>	getWordLangProbMap() The language to word-probability mapping.
void	loadProfile(java.io.File profileDirectory) Load profiles from specified directory.
void	loadProfile(java.util.List<java.lang.String> json_profiles) Load profiles from specified directory.
void	loadProfile(java.lang.String profileDirectory) Load profiles from specified directory.
void	setSeed(long seed)

Methods inherited from class java.lang.Object

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

Constructor Detail

DetectorFactory

public DetectorFactory()

DetectorFactory

public DetectorFactory(java.util.Map<java.lang.String,double[]> wordLangProbMap,
                       java.util.ArrayList<java.lang.String> langlist,
                       long seed)

Method Detail

getSeed

public long getSeed()

setSeed

public void setSeed(long seed)

getLangList

public java.util.List<java.lang.String> getLangList()

The languages that this detector factory knows about.

Returns:

Unmodifiable list.

getWordLangProbMap

public java.util.Map<java.lang.String,double[]> getWordLangProbMap()

The language to word-probability mapping.

Returns:

Unmodifiable map.

loadProfile

public void loadProfile(java.lang.String profileDirectory)
                 throws LangDetectException

Load profiles from specified directory. This method must be called once before language detection.

Parameters:

profileDirectory - profile directory path

Throws:

LangDetectException - Can't open profiles(error code = ErrorCode.FileLoadError) or profile's format is wrong (error code = ErrorCode.FormatError)

loadProfile

public void loadProfile(java.io.File profileDirectory)
                 throws LangDetectException

Load profiles from specified directory. This method must be called once before language detection.

Parameters:

profileDirectory - profile directory path

Throws:

LangDetectException - Can't open profiles(error code = ErrorCode.FileLoadError) or profile's format is wrong (error code = ErrorCode.FormatError)

loadProfile

public void loadProfile(java.util.List<java.lang.String> json_profiles)
                 throws LangDetectException

Load profiles from specified directory. This method must be called once before language detection.

Parameters:

json_profiles - all json-encoded profiles

Throws:

LangDetectException - Can't open profiles(error code = ErrorCode.FileLoadError) or profile's format is wrong (error code = ErrorCode.FormatError)

addProfile

public void addProfile(LangProfile profile,
                       int index,
                       int langsize)
                throws LangDetectException

Parameters:

profile - profile

index - index

langsize - language size

Throws:

LangDetectException - if there's a problem

clear

public void clear()

Clear loaded language profiles (reinitialization to be available)

create

public Detector create()
                throws LangDetectException

Construct Detector instance

Returns:

Detector instance

Throws:

LangDetectException - if there's a problem

create

public Detector create(double alpha)
                throws LangDetectException

Construct Detector instance with smoothing parameter

Parameters:

alpha - smoothing parameter (default value = 0.5)

Returns:

Detector instance

Throws:

LangDetectException - if there's a problem