Package org.apache.lucene.analysis.ja.dict

Class TokenInfoDictionary

java.lang.Object

org.apache.lucene.analysis.ja.dict.BinaryDictionary

org.apache.lucene.analysis.ja.dict.TokenInfoDictionary

All Implemented Interfaces:

Dictionary

public final class TokenInfoDictionary
extends BinaryDictionary

Binary dictionary implementation for a known-word dictionary model: Words are encoded into an FST mapping to a list of wordIDs.

Nested Class Summary

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

BinaryDictionary.ResourceScheme

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FST_FILENAME_SUFFIX

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

DICT_FILENAME_SUFFIX, DICT_HEADER, HAS_BASEFORM, HAS_PRONUNCIATION, HAS_READING, POSDICT_FILENAME_SUFFIX, POSDICT_HEADER, TARGETMAP_FILENAME_SUFFIX, TARGETMAP_HEADER, VERSION

Fields inherited from interface org.apache.lucene.analysis.ja.dict.Dictionary

INTERNAL_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
TokenInfoDictionary(Path targetMapFile, Path posDictFile, Path dictFile, Path fstFile)	Create a TokenInfoDictionary from an external resource path.
TokenInfoDictionary(BinaryDictionary.ResourceScheme resourceScheme, String resourcePath)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by TokenInfoDictionary(Path, Path, Path, Path)

Method Summary

Modifier and Type	Method	Description
TokenInfoFST	getFST()
static TokenInfoDictionary	getInstance()

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

getBaseForm, getInflectionForm, getInflectionType, getLeftId, getPartOfSpeech, getPronunciation, getReading, getResource, getRightId, getWordCost, lookupWordIds

Methods inherited from class java.lang.Object

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

Field Details

FST_FILENAME_SUFFIX

public static final String FST_FILENAME_SUFFIX

See Also:

• Constant Field Values

Constructor Details

TokenInfoDictionary

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

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

replaced by TokenInfoDictionary(Path, Path, Path, Path)

Parameters:

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

resourcePath - - where to load resources (dictionaries) from. If null, with CLASSPATH scheme only, use this class's name as the path.

Throws:

IOException

TokenInfoDictionary

public TokenInfoDictionary(Path targetMapFile,
 Path posDictFile,
 Path dictFile,
 Path fstFile)
                    throws IOException

Create a TokenInfoDictionary 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

fstFile - where to load encoded FST data resource

Throws:

IOException - if resource was not found or broken

Method Details

getFST

public TokenInfoFST getFST()

getInstance

public static TokenInfoDictionary getInstance()