org.apache.lucene.analysis

Class TokenFilter

java.lang.Object

org.apache.lucene.analysis.TokenStream

org.apache.lucene.analysis.TokenFilter

Direct Known Subclasses:

BrazilianStemFilter, ChineseFilter, DutchStemFilter, FrenchStemFilter, GermanStemFilter, GreekLowerCaseFilter, ISOLatin1AccentFilter, LengthFilter, LowerCaseFilter, PorterStemFilter, RussianLowerCaseFilter, RussianStemFilter, SnowballFilter, StandardFilter, StopFilter, SynonymTokenFilter

public abstract class TokenFilter
extends TokenStream

A TokenFilter is a TokenStream whose input is another token stream.

This is an abstract class.

Field Summary

Fields

Modifier and Type	Field and Description
protected TokenStream	input The source of tokens for this filter.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TokenFilter() Deprecated.
protected	TokenFilter(TokenStream input) Construct a token stream filtering the given input.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the input TokenStream.

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

next

Methods inherited from class java.lang.Object

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

Field Detail

input

protected TokenStream input

The source of tokens for this filter.

Constructor Detail

TokenFilter

protected TokenFilter()

Deprecated.

Call TokenFilter(TokenStream) instead.

TokenFilter

protected TokenFilter(TokenStream input)

Construct a token stream filtering the given input.

Method Detail

close

public void close()
           throws IOException

Close the input TokenStream.

Overrides:

close in class TokenStream

Throws:

IOException