org.apache.lucene.analysis

Class CharTokenizer

java.lang.Object

org.apache.lucene.analysis.TokenStream

org.apache.lucene.analysis.Tokenizer

org.apache.lucene.analysis.CharTokenizer

Direct Known Subclasses:

LetterTokenizer, WhitespaceTokenizer

public abstract class CharTokenizer
extends Tokenizer

An abstract base class for simple, character-oriented tokenizers.

Constructor Summary

Constructors

Constructor and Description
CharTokenizer(java.io.Reader input)

Method Summary

Modifier and Type	Method and Description
Token	next(Token token) Returns the next token in the stream, or null at EOS.
void	reset(java.io.Reader input) Expert: Reset the tokenizer to a new reader.

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

close

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

next, reset

Methods inherited from class java.lang.Object

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

Constructor Detail

CharTokenizer

public CharTokenizer(java.io.Reader input)

Method Detail

next

public final Token next(Token token)
                 throws java.io.IOException

Description copied from class: TokenStream

Returns the next token in the stream, or null at EOS. When possible, the input Token should be used as the returned Token (this gives fastest tokenization performance), but this is not required and a new Token may be returned. Callers may re-use a single Token instance for successive calls to this method.

This implicitly defines a "contract" between consumers (callers of this method) and producers (implementations of this method that are the source for tokens):

• A consumer must fully consume the previously returned Token before calling this method again.
• A producer must call Token.clear() before setting the fields in it & returning it

Note that a TokenFilter is considered a consumer.

Overrides:

next in class TokenStream

Parameters:

token - a Token that may or may not be used to return

Returns:

next token in the stream or null if end-of-stream was hit

Throws:

java.io.IOException

reset

public void reset(java.io.Reader input)
           throws java.io.IOException

Description copied from class: Tokenizer

Expert: Reset the tokenizer to a new reader. Typically, an analyzer (in its reusableTokenStream method) will use this to re-use a previously created tokenizer.

Overrides:

reset in class Tokenizer

Throws:

java.io.IOException