Class UserDictionary
- java.lang.Object
-
- org.apache.lucene.analysis.ja.dict.UserDictionary
-
- All Implemented Interfaces:
Dictionary
public final class UserDictionary extends Object implements Dictionary
Class for building a User Dictionary. This class allows for custom segmentation of phrases.
-
-
Field Summary
Fields Modifier and Type Field Description static intLEFT_IDstatic intRIGHT_IDstatic intWORD_COST-
Fields inherited from interface org.apache.lucene.analysis.ja.dict.Dictionary
INTERNAL_SEPARATOR
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetBaseForm(int wordId, char[] surface, int off, int len)Get base form of wordTokenInfoFSTgetFST()StringgetInflectionForm(int wordId)Get inflection form of tokensStringgetInflectionType(int wordId)Get inflection type of tokensintgetLeftId(int wordId)Get left id of specified wordStringgetPartOfSpeech(int wordId)Get Part-Of-Speech of tokensStringgetPronunciation(int wordId, char[] surface, int off, int len)Get pronunciation of tokensStringgetReading(int wordId, char[] surface, int off, int len)Get reading of tokensintgetRightId(int wordId)Get right id of specified wordintgetWordCost(int wordId)Get word cost of specified wordint[][]lookup(char[] chars, int off, int len)Lookup words in textint[]lookupSegmentation(int phraseID)static UserDictionaryopen(Reader reader)
-
-
-
Field Detail
-
WORD_COST
public static final int WORD_COST
- See Also:
- Constant Field Values
-
LEFT_ID
public static final int LEFT_ID
- See Also:
- Constant Field Values
-
RIGHT_ID
public static final int RIGHT_ID
- See Also:
- Constant Field Values
-
-
Method Detail
-
open
public static UserDictionary open(Reader reader) throws IOException
- Throws:
IOException
-
lookup
public int[][] lookup(char[] chars, int off, int len) throws IOExceptionLookup words in text- Parameters:
chars- textoff- offset into textlen- length of text- Returns:
- array of {wordId, position, length}
- Throws:
IOException
-
getFST
public TokenInfoFST getFST()
-
lookupSegmentation
public int[] lookupSegmentation(int phraseID)
-
getLeftId
public int getLeftId(int wordId)
Description copied from interface:DictionaryGet left id of specified word- Specified by:
getLeftIdin interfaceDictionary- Returns:
- left id
-
getRightId
public int getRightId(int wordId)
Description copied from interface:DictionaryGet right id of specified word- Specified by:
getRightIdin interfaceDictionary- Returns:
- right id
-
getWordCost
public int getWordCost(int wordId)
Description copied from interface:DictionaryGet word cost of specified word- Specified by:
getWordCostin interfaceDictionary- Returns:
- word's cost
-
getReading
public String getReading(int wordId, char[] surface, int off, int len)
Description copied from interface:DictionaryGet reading of tokens- Specified by:
getReadingin interfaceDictionary- Parameters:
wordId- word ID of token- Returns:
- Reading of the token
-
getPartOfSpeech
public String getPartOfSpeech(int wordId)
Description copied from interface:DictionaryGet Part-Of-Speech of tokens- Specified by:
getPartOfSpeechin interfaceDictionary- Parameters:
wordId- word ID of token- Returns:
- Part-Of-Speech of the token
-
getBaseForm
public String getBaseForm(int wordId, char[] surface, int off, int len)
Description copied from interface:DictionaryGet base form of word- Specified by:
getBaseFormin interfaceDictionary- Parameters:
wordId- word ID of token- Returns:
- Base form (only different for inflected words, otherwise null)
-
getPronunciation
public String getPronunciation(int wordId, char[] surface, int off, int len)
Description copied from interface:DictionaryGet pronunciation of tokens- Specified by:
getPronunciationin interfaceDictionary- Parameters:
wordId- word ID of token- Returns:
- Pronunciation of the token
-
getInflectionType
public String getInflectionType(int wordId)
Description copied from interface:DictionaryGet inflection type of tokens- Specified by:
getInflectionTypein interfaceDictionary- Parameters:
wordId- word ID of token- Returns:
- inflection type, or null
-
getInflectionForm
public String getInflectionForm(int wordId)
Description copied from interface:DictionaryGet inflection form of tokens- Specified by:
getInflectionFormin interfaceDictionary- Parameters:
wordId- word ID of token- Returns:
- inflection form, or null
-
-