public abstract class

TokenFilter

extends TokenStream
java.lang.Object
   ↳ org.apache.lucene.util.AttributeSource
     ↳ org.apache.lucene.analysis.TokenStream
       ↳ org.apache.lucene.analysis.TokenFilter
Known Direct Subclasses

Class Overview

A TokenFilter is a TokenStream whose input is another TokenStream.

This is an abstract class; subclasses must override incrementToken().

See Also

Summary

Fields
protected final TokenStream input The source of tokens for this filter.
Protected Constructors
TokenFilter(TokenStream input)
Construct a token stream filtering the given input.
Public Methods
void close()
Close the input TokenStream.
void end()
Performs end-of-stream operations, if any, and calls then end() on the input TokenStream.
void reset()
Reset the filter as well as the input TokenStream.
[Expand]
Inherited Methods
From class org.apache.lucene.analysis.TokenStream
From class org.apache.lucene.util.AttributeSource
From class java.lang.Object
From interface java.io.Closeable

Fields

protected final TokenStream input

The source of tokens for this filter.

Protected Constructors

protected TokenFilter (TokenStream input)

Construct a token stream filtering the given input.

Public Methods

public void close ()

Close the input TokenStream.

Throws
IOException

public void end ()

Performs end-of-stream operations, if any, and calls then end() on the input TokenStream.

NOTE: Be sure to call super.end() first when overriding this method.

Throws
IOException

public void reset ()

Reset the filter as well as the input TokenStream.

Throws
IOException