Module org.apache.lucene.analysis.nori

Package org.apache.lucene.analysis.ko.dict

Class UnknownDictionary

java.lang.Object

org.apache.lucene.analysis.ko.dict.BinaryDictionary

org.apache.lucene.analysis.ko.dict.UnknownDictionary

All Implemented Interfaces:

Dictionary

public final class UnknownDictionary
extends BinaryDictionary

Dictionary for unknown-word handling.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	UnknownDictionary.SingletonHolder

Nested classes/interfaces inherited from class org.apache.lucene.analysis.ko.dict.BinaryDictionary

BinaryDictionary.ResourceScheme

Nested classes/interfaces inherited from interface org.apache.lucene.analysis.ko.dict.Dictionary

Dictionary.Morpheme

Field Summary

Fields

Modifier and Type	Field	Description
private final CharacterDefinition	characterDefinition

Fields inherited from class org.apache.lucene.analysis.ko.dict.BinaryDictionary

DICT_FILENAME_SUFFIX, DICT_HEADER, HAS_READING, HAS_SINGLE_POS, POSDICT_FILENAME_SUFFIX, POSDICT_HEADER, TARGETMAP_FILENAME_SUFFIX, TARGETMAP_HEADER, VERSION

Constructor Summary

Constructors

Modifier	Constructor	Description
private	UnknownDictionary()
	UnknownDictionary(URL targetMapUrl, URL posDictUrl, URL dictUrl)	Create a UnknownDictionary from an external resource URL (e.g.
	UnknownDictionary(Path targetMapFile, Path posDictFile, Path dictFile)	Create a UnknownDictionary from an external resource path.
	UnknownDictionary(BinaryDictionary.ResourceScheme scheme, String resourcePath)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by UnknownDictionary(Path, Path, Path) for files and UnknownDictionary(URL, URL, URL) for classpath/module resources

Method Summary

Modifier and Type	Method	Description
CharacterDefinition	getCharacterDefinition()
private static InputStream	getClassResource(String suffix)
static UnknownDictionary	getInstance()
Dictionary.Morpheme[]	getMorphemes(int wordId, char[] surfaceForm, int off, int len)	Get the morphemes of specified word (e.g.
String	getReading(int wordId)	Get the reading of specified word (mainly used for Hanja to Hangul conversion).

Methods inherited from class org.apache.lucene.analysis.ko.dict.BinaryDictionary

getLeftId, getLeftPOS, getPOSType, getResource, getRightId, getRightPOS, getWordCost, lookupWordIds

Methods inherited from class java.lang.Object

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

Field Details

characterDefinition

private final CharacterDefinition characterDefinition

Constructor Details

UnknownDictionary

@Deprecated(forRemoval=true,
            since="9.1")
public UnknownDictionary(BinaryDictionary.ResourceScheme scheme,
 String resourcePath)
                  throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

replaced by UnknownDictionary(Path, Path, Path) for files and UnknownDictionary(URL, URL, URL) for classpath/module resources

Parameters:

scheme - scheme for loading resources (FILE or CLASSPATH).

resourcePath - where to load resources from; a path, including the file base name without extension; this is used to match multiple files with the same base name.

Throws:

IOException

UnknownDictionary

public UnknownDictionary(Path targetMapFile,
 Path posDictFile,
 Path dictFile)
                  throws IOException

Create a UnknownDictionary from an external resource path.

Parameters:

targetMapFile - where to load target map resource

posDictFile - where to load POS dictionary resource

dictFile - where to load dictionary entries resource

Throws:

IOException - if resource was not found or broken

UnknownDictionary

public UnknownDictionary(URL targetMapUrl,
 URL posDictUrl,
 URL dictUrl)
                  throws IOException

Create a UnknownDictionary from an external resource URL (e.g. from Classpath with ClassLoader.getResource(String)).

Parameters:

targetMapUrl - where to load target map resource

posDictUrl - where to load POS dictionary resource

dictUrl - where to load dictionary entries resource

Throws:

IOException - if resource was not found or broken

UnknownDictionary

private UnknownDictionary()
                   throws IOException

Throws:

IOException

Method Details

getClassResource

private static InputStream getClassResource(String suffix)
                                     throws IOException

Throws:

IOException

getCharacterDefinition

public CharacterDefinition getCharacterDefinition()

getInstance

public static UnknownDictionary getInstance()

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 interface Dictionary

Overrides:

getReading in class BinaryDictionary

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 interface Dictionary

Overrides:

getMorphemes in class BinaryDictionary