Lucene.Net.Analysis.Shingle.Codec.TokenSettingsCodec Class Reference

Strategy used to code and decode meta data of the tokens from the input stream regarding how to position the tokens in the matrix, set and retreive weight, etc. More...

Inherited by Lucene.Net.Analysis.Shingle.Codec.OneDimensionalNonWeightedTokenSettingsCodec, Lucene.Net.Analysis.Shingle.Codec.SimpleThreeDimensionalTokenSettingsCodec, and Lucene.Net.Analysis.Shingle.Codec.TwoDimensionalNonWeightedSynonymTokenSettingsCodec.

Public Member Functions
abstract TokenPositioner	GetTokenPositioner (Token token)
	Retrieves information on how a Token is to be inserted to a ShingleMatrixFilter.Matrix.
abstract void	SetTokenPositioner (Token token, TokenPositioner tokenPositioner)
	Sets information on how a Token is to be inserted to a ShingleMatrixFilter.Matrix.
abstract float	GetWeight (Token token)
	Have this method return 1f in order to 'disable' weights.
abstract void	SetWeight (Token token, float weight)
	Have this method do nothing in order to 'disable' weights.

Detailed Description

Strategy used to code and decode meta data of the tokens from the input stream regarding how to position the tokens in the matrix, set and retreive weight, etc.

Definition at line 24 of file TokenSettingsCodec.cs.

Member Function Documentation

abstract TokenPositioner Lucene.Net.Analysis.Shingle.Codec.TokenSettingsCodec.GetTokenPositioner ( Token  token )

pure virtual

Retrieves information on how a Token is to be inserted to a ShingleMatrixFilter.Matrix.

Parameters

token

Returns

Implemented in Lucene.Net.Analysis.Shingle.Codec.SimpleThreeDimensionalTokenSettingsCodec, Lucene.Net.Analysis.Shingle.Codec.TwoDimensionalNonWeightedSynonymTokenSettingsCodec, and Lucene.Net.Analysis.Shingle.Codec.OneDimensionalNonWeightedTokenSettingsCodec.

abstract float Lucene.Net.Analysis.Shingle.Codec.TokenSettingsCodec.GetWeight ( Token  token )

pure virtual

Have this method return 1f in order to 'disable' weights.

Parameters

token

Returns

Implemented in Lucene.Net.Analysis.Shingle.Codec.SimpleThreeDimensionalTokenSettingsCodec, Lucene.Net.Analysis.Shingle.Codec.TwoDimensionalNonWeightedSynonymTokenSettingsCodec, and Lucene.Net.Analysis.Shingle.Codec.OneDimensionalNonWeightedTokenSettingsCodec.

abstract void Lucene.Net.Analysis.Shingle.Codec.TokenSettingsCodec.SetTokenPositioner ( Token  token, TokenPositioner  tokenPositioner  )

pure virtual

Sets information on how a Token is to be inserted to a ShingleMatrixFilter.Matrix.

Parameters

token
tokenPositioner

Implemented in Lucene.Net.Analysis.Shingle.Codec.SimpleThreeDimensionalTokenSettingsCodec, Lucene.Net.Analysis.Shingle.Codec.TwoDimensionalNonWeightedSynonymTokenSettingsCodec, and Lucene.Net.Analysis.Shingle.Codec.OneDimensionalNonWeightedTokenSettingsCodec.

abstract void Lucene.Net.Analysis.Shingle.Codec.TokenSettingsCodec.SetWeight ( Token  token, float  weight  )

pure virtual

Have this method do nothing in order to 'disable' weights.

Parameters

token
weight

Implemented in Lucene.Net.Analysis.Shingle.Codec.SimpleThreeDimensionalTokenSettingsCodec, Lucene.Net.Analysis.Shingle.Codec.TwoDimensionalNonWeightedSynonymTokenSettingsCodec, and Lucene.Net.Analysis.Shingle.Codec.OneDimensionalNonWeightedTokenSettingsCodec.

---

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

• contrib/Analyzers/Shingle/Codec/TokenSettingsCodec.cs