Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | List of all members
Lucene.Net.Analysis.PerFieldAnalyzerWrapper Class Reference

This analyzer is used to facilitate scenarios where different fields require different analysis techniques. Use AddAnalyzer to add a non-default analyzer on a field name basis. More...

Inherits Lucene.Net.Analysis.Analyzer.

Public Member Functions

 PerFieldAnalyzerWrapper (Analyzer defaultAnalyzer)
 Constructs with default analyzer.
 
 PerFieldAnalyzerWrapper (Analyzer defaultAnalyzer, IEnumerable< KeyValuePair< string, Analyzer >> fieldAnalyzers)
 Constructs with default analyzer and a map of analyzers to use for specific fields.
 
virtual void AddAnalyzer (System.String fieldName, Analyzer analyzer)
 Defines an analyzer to use for the specified field.
 
override TokenStream TokenStream (System.String fieldName, System.IO.TextReader reader)
 
override TokenStream ReusableTokenStream (string fieldName, System.IO.TextReader reader)
 
override int GetPositionIncrementGap (string fieldName)
 Return the positionIncrementGap from the analyzer assigned to fieldName
 
override int GetOffsetGap (Documents.IFieldable field)
 Return the offsetGap from the analyzer assigned to field
 
override System.String ToString ()
 
- Public Member Functions inherited from Lucene.Net.Analysis.Analyzer
abstract TokenStream TokenStream (String fieldName, System.IO.TextReader reader)
 Creates a TokenStream which tokenizes all the text in the provided Reader. Must be able to handle null field name for backward compatibility.
 
virtual TokenStream ReusableTokenStream (String fieldName, System.IO.TextReader reader)
 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.
 
virtual int GetPositionIncrementGap (String fieldName)
 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.
 
void Close ()
 Frees persistent resources used by this Analyzer
 
virtual void Dispose ()
 

Additional Inherited Members

- Protected Member Functions inherited from Lucene.Net.Analysis.Analyzer
virtual void Dispose (bool disposing)
 

Detailed Description

This analyzer is used to facilitate scenarios where different fields require different analysis techniques. Use AddAnalyzer 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.

Definition at line 43 of file PerFieldAnalyzerWrapper.cs.

Constructor & Destructor Documentation

Lucene.Net.Analysis.PerFieldAnalyzerWrapper.PerFieldAnalyzerWrapper ( Analyzer  defaultAnalyzer)

Constructs with default analyzer.

Parameters
defaultAnalyzerAny fields not specifically defined to use a different analyzer will use the one provided here.

Definition at line 55 of file PerFieldAnalyzerWrapper.cs.

Lucene.Net.Analysis.PerFieldAnalyzerWrapper.PerFieldAnalyzerWrapper ( Analyzer  defaultAnalyzer,
IEnumerable< KeyValuePair< string, Analyzer >>  fieldAnalyzers 
)

Constructs with default analyzer and a map of analyzers to use for specific fields.

Parameters
defaultAnalyzerAny fields not specifically defined to use a different analyzer will use the one provided here.
fieldAnalyzersa Map (String field name to the Analyzer) to be used for those fields

Definition at line 70 of file PerFieldAnalyzerWrapper.cs.

Member Function Documentation

virtual void Lucene.Net.Analysis.PerFieldAnalyzerWrapper.AddAnalyzer ( System.String  fieldName,
Analyzer  analyzer 
)
virtual

Defines an analyzer to use for the specified field.

Parameters
fieldNamefield name requiring a non-default analyzer
analyzernon-default analyzer to use for field

Definition at line 89 of file PerFieldAnalyzerWrapper.cs.

override int Lucene.Net.Analysis.PerFieldAnalyzerWrapper.GetOffsetGap ( Documents.IFieldable  field)
virtual

Return the offsetGap from the analyzer assigned to field

Reimplemented from Lucene.Net.Analysis.Analyzer.

Definition at line 123 of file PerFieldAnalyzerWrapper.cs.

override int Lucene.Net.Analysis.PerFieldAnalyzerWrapper.GetPositionIncrementGap ( string  fieldName)

Return the positionIncrementGap from the analyzer assigned to fieldName

Definition at line 116 of file PerFieldAnalyzerWrapper.cs.

override TokenStream Lucene.Net.Analysis.PerFieldAnalyzerWrapper.ReusableTokenStream ( string  fieldName,
System.IO.TextReader  reader 
)

Definition at line 101 of file PerFieldAnalyzerWrapper.cs.

override TokenStream Lucene.Net.Analysis.PerFieldAnalyzerWrapper.TokenStream ( System.String  fieldName,
System.IO.TextReader  reader 
)

Definition at line 94 of file PerFieldAnalyzerWrapper.cs.

override System.String Lucene.Net.Analysis.PerFieldAnalyzerWrapper.ToString ( )

Definition at line 129 of file PerFieldAnalyzerWrapper.cs.


The documentation for this class was generated from the following file: