Module org.apache.lucene.analysis.kuromoji

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

Class UserDictionary

java.lang.Object

org.apache.lucene.analysis.ja.dict.UserDictionary

All Implemented Interfaces:

Dictionary<UserMorphData>

public final class UserDictionary
extends Object
implements Dictionary<UserMorphData>

Class for building a User Dictionary. This class allows for custom segmentation of phrases.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final record	UserDictionary.Match

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final int	CUSTOM_DICTIONARY_WORD_ID_OFFSET
private static final int[][]	EMPTY_RESULT
private final TokenInfoFST	fst
static final String	INTERNAL_SEPARATOR
private static final Pattern	LINE_COMMENT
private final UserMorphData	morphAtts
private final int[][]	segmentations
private static final Pattern	SPACES
private static final Pattern	WHITESPACE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	UserDictionary(List<String[]> featureEntries)

Method Summary

Modifier and Type	Method	Description
TokenInfoFST	getFST()
UserMorphData	getMorphAttributes()
int[][]	lookup(char[] chars, int off, int len)	Lookup words in text
int[]	lookupSegmentation(int phraseID)
static UserDictionary	open(Reader reader)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.analysis.morph.Dictionary

getLeftId, getRightId, getWordCost

Field Details

INTERNAL_SEPARATOR

public static final String INTERNAL_SEPARATOR

See Also:

• Constant Field Values

LINE_COMMENT

private static final Pattern LINE_COMMENT

WHITESPACE

private static final Pattern WHITESPACE

SPACES

private static final Pattern SPACES

fst

private final TokenInfoFST fst

segmentations

private final int[][] segmentations

morphAtts

private final UserMorphData morphAtts

CUSTOM_DICTIONARY_WORD_ID_OFFSET

static final int CUSTOM_DICTIONARY_WORD_ID_OFFSET

See Also:

• Constant Field Values

EMPTY_RESULT

private static final int[][] EMPTY_RESULT

Constructor Details

UserDictionary

private UserDictionary(List<String[]> featureEntries)
                throws IOException

Throws:

IOException

Method Details

open

public static UserDictionary open(Reader reader)
                           throws IOException

Throws:

IOException

getMorphAttributes

public UserMorphData getMorphAttributes()

Specified by:

getMorphAttributes in interface Dictionary<UserMorphData>

lookup

public int[][] lookup(char[] chars,
 int off,
 int len)
               throws IOException

Lookup words in text

Parameters:

chars - text

off - offset into text

len - length of text

Returns:

array of {wordId, position, length}

Throws:

IOException

getFST

public TokenInfoFST getFST()

lookupSegmentation

public int[] lookupSegmentation(int phraseID)