org.apache.lucene.analysis
Class TokenStream

java.lang.Object
  extended by org.apache.lucene.analysis.TokenStream
Direct Known Subclasses:
TokenFilter, Tokenizer

public abstract class TokenStream
extends java.lang.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:


Constructor Summary
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TokenStream

public TokenStream()
Method Detail

next

public abstract Token next()
                    throws java.io.IOException
Returns the next token in the stream, or null at EOS.

Throws:
java.io.IOException

reset

public void reset()
           throws java.io.IOException
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().

Throws:
java.io.IOException

close

public void close()
           throws java.io.IOException
Releases resources associated with this stream.

Throws:
java.io.IOException


Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.