Package org.apache.lucene.analysis.cn

Class ChineseFilter

java.lang.Object

org.apache.lucene.util.AttributeSource

org.apache.lucene.analysis.TokenStream

org.apache.lucene.analysis.TokenFilter

org.apache.lucene.analysis.cn.ChineseFilter

All Implemented Interfaces:

Closeable, AutoCloseable

@Deprecated
public final class ChineseFilter
extends TokenFilter

Deprecated.

(3.1) Use StopFilter instead, which has the same functionality. This filter will be removed in Lucene 5.0

A TokenFilter with a stop word table.

• Numeric tokens are removed.
• English tokens must be larger than 1 character.
• One Chinese character as one Chinese word.

TO DO:

1. Add Chinese stop words, such as 
2. Dictionary based Chinese word extraction
3. Intelligent Chinese word extraction

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource

AttributeSource.AttributeFactory, AttributeSource.State

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	STOP_WORDS	Deprecated.

Constructor Summary

Constructors

Constructor	Description
ChineseFilter(TokenStream in)	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	incrementToken()	Deprecated. Consumers (i.e., IndexWriter) use this method to advance the stream to the next token.

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

close, end, reset

Methods inherited from class org.apache.lucene.util.AttributeSource

addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

STOP_WORDS

public static final String[] STOP_WORDS

Deprecated.

Constructor Details

ChineseFilter

public ChineseFilter(TokenStream in)

Deprecated.

Method Details

incrementToken

public boolean incrementToken()
                       throws IOException

Deprecated.

Description copied from class: TokenStream

Consumers (i.e., IndexWriter) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriate AttributeImpls with the attributes of the next token.

The producer must make no assumptions about the attributes after the method has been returned: the caller may arbitrarily change it. If the producer needs to preserve the state for subsequent calls, it can use AttributeSource.captureState() to create a copy of the current attribute state.

This method is called for every token of a document, so an efficient implementation is crucial for good performance. To avoid calls to AttributeSource.addAttribute(Class) and AttributeSource.getAttribute(Class), references to all AttributeImpls that this stream uses should be retrieved during instantiation.

To ensure that filters and consumers know which attributes are available, the attributes must be added during instantiation. Filters and consumers are not required to check for availability of attributes in TokenStream.incrementToken().

Specified by:

incrementToken in class TokenStream

Returns:

false for end of stream; true otherwise

Throws:

IOException