org.apache.lucene.analysis
Class TokenStream
public abstract
class
TokenStream
extends Object
A TokenStream enumerates the sequence of tokens, either from
fields of a document or from query text.
This is an abstract class. Concrete subclasses are:
- Tokenizer, a TokenStream
whose input is a Reader; and
- TokenFilter, a TokenStream
whose input is another TokenStream.
Method Summary |
void | close() Releases resources associated with this stream. |
abstract Token | next() Returns the next token in the stream, or null at EOS. |
void | reset() Resets this stream to the beginning. |
public void close()
Releases resources associated with this stream.
public abstract
Token next()
Returns the next token in the stream, or null at EOS.
public void reset()
Resets this stream to the beginning. This is an
optional operation, so subclasses may or may not
implement this method. Reset() is not needed for
the standard indexing process. However, if the Tokens
of a TokenStream are intended to be consumed more than
once, it is neccessary to implement reset().
Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.