org.apache.lucene.analysis
Class Analyzer

java.lang.Object
  |
  +--org.apache.lucene.analysis.Analyzer

Direct Known Subclasses:

GermanAnalyzer, SimpleAnalyzer, StandardAnalyzer, StopAnalyzer, WhitespaceAnalyzer

public abstract class Analyzer

extends Object

An Analyzer builds TokenStreams, which analyze text. It thus represents a policy for extracting index terms from text.

Typical implementations first build a Tokenizer, which breaks the stream of characters from the Reader into raw Tokens. One or more TokenFilters may then be applied to the output of the Tokenizer.

WARNING: You must override one of the methods defined by this class in your subclass or the Analyzer will enter an infinite loop.

Constructor Summary

Analyzer()

Method Summary

TokenStream	tokenStream(Reader reader) Deprecated. use tokenStream(String, Reader) instead.
TokenStream	tokenStream(String fieldName, Reader reader) Creates a TokenStream which tokenizes all the text in the provided Reader.

Methods inherited from class java.lang.Object

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

Constructor Detail

Analyzer

public Analyzer()

Method Detail

tokenStream

public TokenStream tokenStream(String fieldName,
                               Reader reader)

Creates a TokenStream which tokenizes all the text in the provided Reader. Default implementation forwards to tokenStream(Reader) for compatibility with older version. Override to allow Analyzer to choose strategy based on document and/or field. Must be able to handle null field name for backward compatibility.

tokenStream

public TokenStream tokenStream(Reader reader)

Deprecated. use tokenStream(String, Reader) instead.

Creates a TokenStream which tokenizes all the text in the provided Reader. Provided for backward compatibility only.

See Also:

tokenStream(String, Reader)