Documentation  › org.apache.lucene.analysis  › Analyzer
 
 


  Analyzer
  public abstract

  Inherits From:   Object
  Conforms To:   none
  Declared In:   org.apache.lucene.analysis


Class Description
 
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.



Class Variables
 
None declared in this class.


Instance Variables
 
None declared in this class.


Constructors
 
Analyzer
public Analyzer( )

No description available for this constructor.


Class Methods
 
None declared in this class.


Instance Methods
 
tokenStream
public TokenStream tokenStream( Reader reader )

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


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.


Known Subclasses
 
GermanAnalyzer, PerFieldAnalyzerWrapper, RussianAnalyzer, SimpleAnalyzer, StandardAnalyzer, StopAnalyzer, WhitespaceAnalyzer



 
 
  dydoc
  3/9/05