Module org.apache.lucene.analysis.common

Package org.apache.lucene.analysis.cjk

Class CJKAnalyzer

java.lang.Object

org.apache.lucene.analysis.Analyzer

org.apache.lucene.analysis.StopwordAnalyzerBase

org.apache.lucene.analysis.cjk.CJKAnalyzer

All Implemented Interfaces:

Closeable, AutoCloseable

public final class CJKAnalyzer
extends StopwordAnalyzerBase

An Analyzer that tokenizes text with StandardTokenizer, normalizes content with CJKWidthFilter, folds case with LowerCaseFilter, forms bigrams of CJK with CJKBigramFilter, and filters stopwords with StopFilter

Since:

3.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	CJKAnalyzer.DefaultSetHolder

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

Analyzer.ReuseStrategy, Analyzer.TokenStreamComponents

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_STOPWORD_FILE	File containing default CJK stopwords.

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
CJKAnalyzer()	Builds an analyzer which removes words in getDefaultStopSet().
CJKAnalyzer(CharArraySet stopwords)	Builds an analyzer with the given stop words

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()	Returns an unmodifiable instance of the default stop-words set.
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, initReader, initReaderForNormalization, normalize, tokenStream, tokenStream

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_STOPWORD_FILE

public static final String DEFAULT_STOPWORD_FILE

File containing default CJK stopwords.

Currently it contains some common English words that are not usually useful for searching and some double-byte interpunctions.

See Also:

• Constant Field Values

Constructor Details

CJKAnalyzer

public CJKAnalyzer()

Builds an analyzer which removes words in getDefaultStopSet().

CJKAnalyzer

public CJKAnalyzer(CharArraySet stopwords)

Builds an analyzer with the given stop words

Parameters:

stopwords - a stopword set

Method Details

getDefaultStopSet

public static CharArraySet getDefaultStopSet()

Returns an unmodifiable instance of the default stop-words set.

Returns:

an unmodifiable instance of the default stop-words set.

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