org.apache.lucene.analysis
Class PerFieldAnalyzerWrapper

java.lang.Object
  org.apache.lucene.analysis.Analyzer
      org.apache.lucene.analysis.PerFieldAnalyzerWrapper

public class PerFieldAnalyzerWrapper

extends Analyzer

This analyzer is used to facilitate scenarios where different fields require different analysis techniques. Use addAnalyzer(java.lang.String, org.apache.lucene.analysis.Analyzer) to add a non-default analyzer on a field name basis.

Example usage:

   PerFieldAnalyzerWrapper aWrapper =
      new PerFieldAnalyzerWrapper(new StandardAnalyzer());
   aWrapper.addAnalyzer("firstname", new KeywordAnalyzer());
   aWrapper.addAnalyzer("lastname", new KeywordAnalyzer());
 

In this example, StandardAnalyzer will be used for all fields except "firstname" and "lastname", for which KeywordAnalyzer will be used.

A PerFieldAnalyzerWrapper can be used like any other analyzer, for both indexing and query parsing.

Constructor Summary

PerFieldAnalyzerWrapper(Analyzer defaultAnalyzer)
Constructs with default analyzer.

Method Summary

void	addAnalyzer(java.lang.String fieldName, Analyzer analyzer) Defines an analyzer to use for the specified field.
TokenStream	tokenStream(java.lang.String fieldName, java.io.Reader reader) Creates a TokenStream which tokenizes all the text in the provided Reader.
java.lang.String	toString()

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

getPositionIncrementGap, tokenStream

Methods inherited from class java.lang.Object

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

Constructor Detail

PerFieldAnalyzerWrapper

public PerFieldAnalyzerWrapper(Analyzer defaultAnalyzer)

Constructs with default analyzer.

Parameters:

defaultAnalyzer - Any fields not specifically defined to use a different analyzer will use the one provided here.

Method Detail

addAnalyzer

public void addAnalyzer(java.lang.String fieldName,
                        Analyzer analyzer)

Defines an analyzer to use for the specified field.

Parameters:

fieldName - field name requiring a non-default analyzer

analyzer - non-default analyzer to use for field

tokenStream

public TokenStream tokenStream(java.lang.String fieldName,
                               java.io.Reader reader)

Description copied from class: Analyzer

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.

Overrides:

tokenStream in class Analyzer

toString

public java.lang.String toString()