Module org.apache.lucene.analysis.kuromoji

Package org.apache.lucene.analysis.ja

Class JapaneseAnalyzer

java.lang.Object

org.apache.lucene.analysis.Analyzer

org.apache.lucene.analysis.StopwordAnalyzerBase

org.apache.lucene.analysis.ja.JapaneseAnalyzer

All Implemented Interfaces:

Closeable, AutoCloseable

public class JapaneseAnalyzer
extends StopwordAnalyzerBase

Analyzer for Japanese that uses morphological analysis.

Since:

3.6.0

See Also:

• JapaneseTokenizer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	JapaneseAnalyzer.DefaultSetHolder	Atomically loads DEFAULT_STOP_SET, DEFAULT_STOP_TAGS in a lazy fashion once the outer class accesses the static final set the first time.

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 JapaneseTokenizer.Mode	mode
private final Set<String>	stoptags
private final UserDictionary	userDict

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

stopwords

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

GLOBAL_REUSE_STRATEGY, PER_FIELD_REUSE_STRATEGY

Constructor Summary

Constructors

Constructor	Description
JapaneseAnalyzer()
JapaneseAnalyzer(UserDictionary userDict, JapaneseTokenizer.Mode mode, CharArraySet stopwords, Set<String> stoptags)

Method Summary

Modifier and Type	Method	Description
protected Analyzer.TokenStreamComponents	createComponents(String fieldName)	Creates a new Analyzer.TokenStreamComponents instance for this analyzer.
static CharArraySet	getDefaultStopSet()
static Set<String>	getDefaultStopTags()
protected Reader	initReader(String fieldName, Reader reader)	Override this if you want to add a CharFilter chain.
protected Reader	initReaderForNormalization(String fieldName, Reader reader)	Wrap the given Reader with CharFilters that make sense for normalization.
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.StopwordAnalyzerBase

getStopwordSet, loadStopwordSet, loadStopwordSet, loadStopwordSet

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

attributeFactory, close, getOffsetGap, getPositionIncrementGap, getReuseStrategy, normalize, tokenStream, tokenStream

Methods inherited from class java.lang.Object

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

Field Details

mode

private final JapaneseTokenizer.Mode mode

stoptags

private final Set<String> stoptags

userDict

private final UserDictionary userDict

Constructor Details

JapaneseAnalyzer

public JapaneseAnalyzer()

JapaneseAnalyzer

public JapaneseAnalyzer(UserDictionary userDict,
 JapaneseTokenizer.Mode mode,
 CharArraySet stopwords,
 Set<String> stoptags)

Method Details

getDefaultStopSet

public static CharArraySet getDefaultStopSet()

getDefaultStopTags

public static Set<String> getDefaultStopTags()

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

initReader

protected Reader initReader(String fieldName,
 Reader reader)

Description copied from class: Analyzer

Override this if you want to add a CharFilter chain.

The default implementation returns reader unchanged.

Overrides:

initReader in class Analyzer

Parameters:

fieldName - IndexableField name being indexed

reader - original Reader

Returns:

reader, optionally decorated with CharFilter(s)

initReaderForNormalization

protected Reader initReaderForNormalization(String fieldName,
 Reader reader)

Description copied from class: Analyzer

Wrap the given Reader with CharFilters that make sense for normalization. This is typically a subset of the CharFilters that are applied in Analyzer.initReader(String, Reader). This is used by Analyzer.normalize(String, String).

Overrides:

initReaderForNormalization in class Analyzer