com.atilika.kuromoji.dict

Class UserDictionary

java.lang.Object

com.atilika.kuromoji.dict.UserDictionary

All Implemented Interfaces:

Dictionary

public class UserDictionary
extends java.lang.Object
implements Dictionary

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserDictionary.UserDictionaryMatch

Constructor Summary

Constructors

Constructor and Description
UserDictionary(java.io.InputStream inputStream, int totalFeatures, int readingFeature, int partOfSpeechFeature)

Method Summary

Modifier and Type	Method and Description
void	addEntry(java.lang.String entry)
java.util.List<UserDictionary.UserDictionaryMatch>	findUserDictionaryMatches(java.lang.String text) Lookup words in text
java.lang.String	getAllFeatures(int wordId) Gets all features of the specified word id
java.lang.String[]	getAllFeaturesArray(int wordId) Gets all features of the specified word id as a String array
java.lang.String	getFeature(int wordId, int... fields) Gets one or more specific features of a token
int	getLeftId(int wordId) Gets the left id of the specified word
int	getRightId(int wordId) Gets the right id of the specified word
int	getWordCost(int wordId) Gets the word cost of the specified word
void	read(java.io.InputStream input)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserDictionary

public UserDictionary(java.io.InputStream inputStream,
                      int totalFeatures,
                      int readingFeature,
                      int partOfSpeechFeature)
               throws java.io.IOException

Throws:

java.io.IOException

Method Detail

findUserDictionaryMatches

public java.util.List<UserDictionary.UserDictionaryMatch> findUserDictionaryMatches(java.lang.String text)

Lookup words in text

Parameters:

text - text to look up user dictionary matches for

Returns:

list of UserDictionaryMatch, not null

getLeftId

public int getLeftId(int wordId)

Description copied from interface: Dictionary

Gets the left id of the specified word

Specified by:

getLeftId in interface Dictionary

Parameters:

wordId - word id to get left id cost for

Returns:

left id cost

getRightId

public int getRightId(int wordId)

Description copied from interface: Dictionary

Gets the right id of the specified word

Specified by:

getRightId in interface Dictionary

Parameters:

wordId - word id to get right id cost for

Returns:

right id cost

getWordCost

public int getWordCost(int wordId)

Description copied from interface: Dictionary

Gets the word cost of the specified word

Specified by:

getWordCost in interface Dictionary

Parameters:

wordId - word id to get word cost for

Returns:

word cost

getAllFeaturesArray

public java.lang.String[] getAllFeaturesArray(int wordId)

Description copied from interface: Dictionary

Gets all features of the specified word id as a String array

Specified by:

getAllFeaturesArray in interface Dictionary

Parameters:

wordId - word id to get features for

Returns:

Array with all features

getAllFeatures

public java.lang.String getAllFeatures(int wordId)

Description copied from interface: Dictionary

Gets all features of the specified word id

Specified by:

getAllFeatures in interface Dictionary

Parameters:

wordId - word id to get features for

Returns:

All features as a string

getFeature

public java.lang.String getFeature(int wordId,
                                   int... fields)

Description copied from interface: Dictionary

Gets one or more specific features of a token

This is an expert API

Specified by:

getFeature in interface Dictionary

Parameters:

wordId - word id to get features for

fields - array of feature ids. If this array is empty, all features are returned

Returns:

Array with specified features

read

public void read(java.io.InputStream input)
          throws java.io.IOException

Throws:

java.io.IOException

addEntry

public void addEntry(java.lang.String entry)