Package org.apache.lucene.analysis.ko

Class KoreanAnalyzer

java.lang.Object

org.apache.lucene.analysis.Analyzer

org.apache.lucene.analysis.ko.KoreanAnalyzer

All Implemented Interfaces:

Closeable, AutoCloseable

public class KoreanAnalyzer
extends Analyzer

Analyzer for Korean that uses morphological analysis.

Since:

7.4.0

See Also:

• KoreanTokenizer

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.analysis.Analyzer

Analyzer.ReuseStrategy, Analyzer.TokenStreamComponents

Field Summary

Fields

Modifier and Type	Field	Description
private final KoreanTokenizer.DecompoundMode	mode
private final boolean	outputUnknownUnigrams
private final Set<POS.Tag>	stopTags
private final UserDictionary	userDict

Fields inherited from class org.apache.lucene.analysis.Analyzer

GLOBAL_REUSE_STRATEGY, PER_FIELD_REUSE_STRATEGY

Constructor Summary

Constructors

Constructor	Description
KoreanAnalyzer()	Creates a new KoreanAnalyzer.
KoreanAnalyzer(UserDictionary userDict, KoreanTokenizer.DecompoundMode mode, Set<POS.Tag> stopTags, boolean outputUnknownUnigrams)	Creates a new KoreanAnalyzer.

Method Summary

Modifier and Type	Method	Description
protected Analyzer.TokenStreamComponents	createComponents(String fieldName)	Creates a new Analyzer.TokenStreamComponents instance for this analyzer.
protected TokenStream	normalize(String fieldName, TokenStream in)	Wrap the given TokenStream in order to apply normalization filters.

Methods inherited from class org.apache.lucene.analysis.Analyzer

attributeFactory, close, getOffsetGap, getPositionIncrementGap, getReuseStrategy, getVersion, initReader, initReaderForNormalization, normalize, setVersion, tokenStream, tokenStream

Methods inherited from class java.lang.Object

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

Field Details

userDict

private final UserDictionary userDict

mode

private final KoreanTokenizer.DecompoundMode mode

stopTags

private final Set<POS.Tag> stopTags

outputUnknownUnigrams

private final boolean outputUnknownUnigrams

Constructor Details

KoreanAnalyzer

public KoreanAnalyzer()

Creates a new KoreanAnalyzer.

KoreanAnalyzer

public KoreanAnalyzer(UserDictionary userDict,
 KoreanTokenizer.DecompoundMode mode,
 Set<POS.Tag> stopTags,
 boolean outputUnknownUnigrams)

Creates a new KoreanAnalyzer.

Parameters:

userDict - Optional: if non-null, user dictionary.

mode - Decompound mode.

stopTags - The set of part of speech that should be filtered.

outputUnknownUnigrams - If true outputs unigrams for unknown words.

Method Details

createComponents

protected Analyzer.TokenStreamComponents createComponents(String fieldName)

Description copied from class: Analyzer

Creates a new Analyzer.TokenStreamComponents instance for this analyzer.

Specified by:

createComponents in class Analyzer

Parameters:

fieldName - the name of the fields content passed to the Analyzer.TokenStreamComponents sink as a reader

Returns:

the Analyzer.TokenStreamComponents for this analyzer.

normalize

protected TokenStream normalize(String fieldName,
 TokenStream in)

Description copied from class: Analyzer

Wrap the given TokenStream in order to apply normalization filters. The default implementation returns the TokenStream as-is. This is used by Analyzer.normalize(String, String).

Overrides:

normalize in class Analyzer