Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## 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. See TestPerFieldAnalyzerWrapper.java for example usage.

Constructor Summary
`PerFieldAnalyzerWrapper(Analyzer defaultAnalyzer)` Constructs with default analyzer.

Method Summary
`void` | `addAnalyzer(String fieldName, Analyzer analyzer)` Defines an analyzer to use for the specified field.
`TokenStream` | `tokenStream(String fieldName, Reader reader)` Creates a TokenStream which tokenizes all the text in the provided Reader.

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

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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(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(String fieldName,
                                   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`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.