Class UserDictionary
- java.lang.Object
-
- org.apache.lucene.analysis.ko.dict.UserDictionary
-
- All Implemented Interfaces:
Dictionary
public final class UserDictionary extends Object implements Dictionary
Class for building a User Dictionary. This class allows for adding custom nouns (세종) or compounds (세종시 세종 시).
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.lucene.analysis.ko.dict.Dictionary
Dictionary.Morpheme
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description TokenInfoFSTgetFST()intgetLeftId(int wordId)Get left id of specified wordPOS.TaggetLeftPOS(int wordId)Get the leftPOS.Tagof specfied word.Dictionary.Morpheme[]getMorphemes(int wordId, char[] surfaceForm, int off, int len)Get the morphemes of specified word (e.g.POS.TypegetPOSType(int wordId)Get thePOS.Typeof specified word (morpheme, compound, inflect or pre-analysis)StringgetReading(int wordId)Get the reading of specified word (mainly used for Hanja to Hangul conversion).intgetRightId(int wordId)Get right id of specified wordPOS.TaggetRightPOS(int wordId)Get the rightPOS.Tagof specfied word.intgetWordCost(int wordId)Get word cost of specified wordList<Integer>lookup(char[] chars, int off, int len)Lookup words in textstatic UserDictionaryopen(Reader reader)
-
-
-
Method Detail
-
open
public static UserDictionary open(Reader reader) throws IOException
- Throws:
IOException
-
getFST
public TokenInfoFST getFST()
-
getLeftId
public int getLeftId(int wordId)
Description copied from interface:DictionaryGet left id of specified word- Specified by:
getLeftIdin interfaceDictionary
-
getRightId
public int getRightId(int wordId)
Description copied from interface:DictionaryGet right id of specified word- Specified by:
getRightIdin interfaceDictionary
-
getWordCost
public int getWordCost(int wordId)
Description copied from interface:DictionaryGet word cost of specified word- Specified by:
getWordCostin interfaceDictionary
-
getPOSType
public POS.Type getPOSType(int wordId)
Description copied from interface:DictionaryGet thePOS.Typeof specified word (morpheme, compound, inflect or pre-analysis)- Specified by:
getPOSTypein interfaceDictionary
-
getLeftPOS
public POS.Tag getLeftPOS(int wordId)
Description copied from interface:DictionaryGet the leftPOS.Tagof specfied word.For
POS.Type.MORPHEMEandPOS.Type.COMPOUNDthe left and right POS are the same.- Specified by:
getLeftPOSin interfaceDictionary
-
getRightPOS
public POS.Tag getRightPOS(int wordId)
Description copied from interface:DictionaryGet the rightPOS.Tagof specfied word.For
POS.Type.MORPHEMEandPOS.Type.COMPOUNDthe left and right POS are the same.- Specified by:
getRightPOSin interfaceDictionary
-
getReading
public String getReading(int wordId)
Description copied from interface:DictionaryGet the reading of specified word (mainly used for Hanja to Hangul conversion).- Specified by:
getReadingin interfaceDictionary
-
getMorphemes
public Dictionary.Morpheme[] getMorphemes(int wordId, char[] surfaceForm, int off, int len)
Description copied from interface:DictionaryGet the morphemes of specified word (e.g. 가깝으나: 가깝 + 으나).- Specified by:
getMorphemesin interfaceDictionary
-
lookup
public List<Integer> lookup(char[] chars, int off, int len) throws IOException
Lookup words in text- Parameters:
chars- textoff- offset into textlen- length of text- Returns:
- array of wordId
- Throws:
IOException
-
-