Lucene.Net.Analysis.Shingle.ShingleAnalyzerWrapper Class Reference

Inherits Lucene.Net.Analysis.Analyzer.

Public Member Functions
	ShingleAnalyzerWrapper (Analyzer defaultAnalyzer)
	ShingleAnalyzerWrapper (Analyzer defaultAnalyzer, int maxShingleSize)
	ShingleAnalyzerWrapper (Version matchVersion)
	ShingleAnalyzerWrapper (Version matchVersion, int nGramSize)
override TokenStream	TokenStream (String fieldName, TextReader reader)
override TokenStream	ReusableTokenStream (String fieldName, TextReader reader)
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.
virtual int	GetOffsetGap (IFieldable field)
	Just like GetPositionIncrementGap, except for Token offsets instead. By default this returns 1 for tokenized fields and, as if the fields were joined with an extra space character, and 0 for un-tokenized fields. This method is only called if the field produced at least one token for indexing.
void	Close ()
	Frees persistent resources used by this Analyzer
virtual void	Dispose ()

Protected Attributes
Analyzer	defaultAnalyzer
int	maxShingleSize = 2
bool	outputUnigrams = true

Properties
int	MaxShingleSize [get, set]
	Gets or sets the max shingle (ngram) size
bool	IsOutputUnigrams [get, set]
	Gets or sets whether or not to have the filter pass the original tokens (the "unigrams") to the output stream

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

Detailed Description

Definition at line 31 of file ShingleAnalyzerWrapper.cs.

Constructor & Destructor Documentation

Lucene.Net.Analysis.Shingle.ShingleAnalyzerWrapper.ShingleAnalyzerWrapper

(

Analyzer

defaultAnalyzer

)

Definition at line 38 of file ShingleAnalyzerWrapper.cs.

Lucene.Net.Analysis.Shingle.ShingleAnalyzerWrapper.ShingleAnalyzerWrapper	(	Analyzer	defaultAnalyzer,
		int	maxShingleSize
	)

Definition at line 44 of file ShingleAnalyzerWrapper.cs.

Lucene.Net.Analysis.Shingle.ShingleAnalyzerWrapper.ShingleAnalyzerWrapper

(

Version

matchVersion

)

Definition at line 54 of file ShingleAnalyzerWrapper.cs.

Lucene.Net.Analysis.Shingle.ShingleAnalyzerWrapper.ShingleAnalyzerWrapper	(	Version	matchVersion,
		int	nGramSize
	)

Definition at line 63 of file ShingleAnalyzerWrapper.cs.

Member Function Documentation

override TokenStream Lucene.Net.Analysis.Shingle.ShingleAnalyzerWrapper.ReusableTokenStream	(	String	fieldName,
		TextReader	reader
	)

Definition at line 110 of file ShingleAnalyzerWrapper.cs.

override TokenStream Lucene.Net.Analysis.Shingle.ShingleAnalyzerWrapper.TokenStream	(	String	fieldName,
		TextReader	reader
	)

Definition at line 87 of file ShingleAnalyzerWrapper.cs.

Member Data Documentation

Analyzer Lucene.Net.Analysis.Shingle.ShingleAnalyzerWrapper.defaultAnalyzer

protected

Definition at line 34 of file ShingleAnalyzerWrapper.cs.

int Lucene.Net.Analysis.Shingle.ShingleAnalyzerWrapper.maxShingleSize = 2

protected

Definition at line 35 of file ShingleAnalyzerWrapper.cs.

bool Lucene.Net.Analysis.Shingle.ShingleAnalyzerWrapper.outputUnigrams = true

protected

Definition at line 36 of file ShingleAnalyzerWrapper.cs.

Property Documentation

bool Lucene.Net.Analysis.Shingle.ShingleAnalyzerWrapper.IsOutputUnigrams

getset

Gets or sets whether or not to have the filter pass the original tokens (the "unigrams") to the output stream

Definition at line 82 of file ShingleAnalyzerWrapper.cs.

int Lucene.Net.Analysis.Shingle.ShingleAnalyzerWrapper.MaxShingleSize

getset

Gets or sets the max shingle (ngram) size

Definition at line 73 of file ShingleAnalyzerWrapper.cs.

---

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

• contrib/Analyzers/Shingle/ShingleAnalyzerWrapper.cs