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 TokenInfoFST
getFST()
int
getLeftId(int wordId)
Get left id of specified wordPOS.Tag
getLeftPOS(int wordId)
Get the leftPOS.Tag
of specfied word.Dictionary.Morpheme[]
getMorphemes(int wordId, char[] surfaceForm, int off, int len)
Get the morphemes of specified word (e.g.POS.Type
getPOSType(int wordId)
Get thePOS.Type
of specified word (morpheme, compound, inflect or pre-analysis)String
getReading(int wordId)
Get the reading of specified word (mainly used for Hanja to Hangul conversion).int
getRightId(int wordId)
Get right id of specified wordPOS.Tag
getRightPOS(int wordId)
Get the rightPOS.Tag
of specfied word.int
getWordCost(int wordId)
Get word cost of specified wordList<Integer>
lookup(char[] chars, int off, int len)
Lookup words in textstatic UserDictionary
open(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:Dictionary
Get left id of specified word- Specified by:
getLeftId
in interfaceDictionary
-
getRightId
public int getRightId(int wordId)
Description copied from interface:Dictionary
Get right id of specified word- Specified by:
getRightId
in interfaceDictionary
-
getWordCost
public int getWordCost(int wordId)
Description copied from interface:Dictionary
Get word cost of specified word- Specified by:
getWordCost
in interfaceDictionary
-
getPOSType
public POS.Type getPOSType(int wordId)
Description copied from interface:Dictionary
Get thePOS.Type
of specified word (morpheme, compound, inflect or pre-analysis)- Specified by:
getPOSType
in interfaceDictionary
-
getLeftPOS
public POS.Tag getLeftPOS(int wordId)
Description copied from interface:Dictionary
Get the leftPOS.Tag
of specfied word. ForPOS.Type.MORPHEME
andPOS.Type.COMPOUND
the left and right POS are the same.- Specified by:
getLeftPOS
in interfaceDictionary
-
getRightPOS
public POS.Tag getRightPOS(int wordId)
Description copied from interface:Dictionary
Get the rightPOS.Tag
of specfied word. ForPOS.Type.MORPHEME
andPOS.Type.COMPOUND
the left and right POS are the same.- Specified by:
getRightPOS
in interfaceDictionary
-
getReading
public String getReading(int wordId)
Description copied from interface:Dictionary
Get the reading of specified word (mainly used for Hanja to Hangul conversion).- Specified by:
getReading
in interfaceDictionary
-
getMorphemes
public Dictionary.Morpheme[] getMorphemes(int wordId, char[] surfaceForm, int off, int len)
Description copied from interface:Dictionary
Get the morphemes of specified word (e.g. 가깝으나: 가깝 + 으나).- Specified by:
getMorphemes
in 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
-
-