| java.lang.Object
 org.apache.lucene.analysis.Analyzer
All known Subclasses: org.apache.lucene.analysis.de.GermanAnalyzer, org.apache.lucene.analysis.nl.DutchAnalyzer, org.apache.lucene.analysis.br.BrazilianAnalyzer, org.apache.lucene.analysis.el.GreekAnalyzer, org.apache.lucene.analysis.standard.StandardAnalyzer, org.apache.lucene.analysis.StopAnalyzer, org.apache.lucene.index.memory.PatternAnalyzer, org.apache.lucene.analysis.th.ThaiAnalyzer, org.apache.lucene.analysis.cjk.CJKAnalyzer, org.apache.lucene.analysis.cn.ChineseAnalyzer, org.apache.lucene.analysis.snowball.SnowballAnalyzer, org.apache.lucene.analysis.ru.RussianAnalyzer, org.apache.lucene.analysis.WhitespaceAnalyzer, org.apache.lucene.analysis.PerFieldAnalyzerWrapper, org.apache.lucene.analysis.KeywordAnalyzer, org.apache.lucene.analysis.fr.FrenchAnalyzer, org.apache.lucene.analysis.cz.CzechAnalyzer, org.apache.lucene.analysis.SimpleAnalyzer,
| Analyzer | | abstract public class Analyzer (Code) | | 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.
|
| Method Summary | |
| public int | getPositionIncrementGap(String fieldName)
Invoked before indexing a Fieldable instance if
terms have already been added to that field. | | protected Object | getPreviousTokenStream()
Used by Analyzers that implement reusableTokenStream
to retrieve previously saved TokenStreams for re-use
by the same thread. | | public TokenStream | reusableTokenStream(String fieldName, Reader reader)
Creates a TokenStream that is allowed to be re-used
from the previous time that the same thread called
this method. | | protected void | setPreviousTokenStream(Object obj)
Used by Analyzers that implement reusableTokenStream
to save a TokenStream for later re-use by the same
thread. | | abstract public TokenStream | tokenStream(String fieldName, Reader reader)
Creates a TokenStream which tokenizes all the text in the provided
Reader. |
| getPositionIncrementGap | | public int getPositionIncrementGap(String fieldName)(Code) | | Invoked before indexing a Fieldable instance if
terms have already been added to that field. This allows custom
analyzers to place an automatic position increment gap between
Fieldable instances using the same field name. The default value
position increment gap is 0. With a 0 position increment gap and
the typical default token position increment of 1, all terms in a field,
including across Fieldable instances, are in successive positions, allowing
exact PhraseQuery matches, for instance, across Fieldable instance boundaries.
Parameters:
fieldName - Fieldable name being indexed. position increment gap, added to the next token emitted from Analyzer.tokenStream(String,Reader) |
| getPreviousTokenStream | | protected Object getPreviousTokenStream()(Code) | | Used by Analyzers that implement reusableTokenStream
to retrieve previously saved TokenStreams for re-use
by the same thread.
|
| reusableTokenStream | | public TokenStream reusableTokenStream(String fieldName, Reader reader) throws IOException(Code) | | Creates a TokenStream that is allowed to be re-used
from the previous time that the same thread called
this method. Callers that do not need to use more
than one TokenStream at the same time from this
analyzer should use this method for better
performance.
|
| setPreviousTokenStream | | protected void setPreviousTokenStream(Object obj)(Code) | | Used by Analyzers that implement reusableTokenStream
to save a TokenStream for later re-use by the same
thread.
|
| tokenStream | | abstract public TokenStream tokenStream(String fieldName, Reader reader)(Code) | | 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.
|
|
|