Class SynonymFilter

Matches single or multi word synonyms in a token stream. This token stream cannot properly handle position increments != 1, ie, you should place this filter before filtering out stop words.

Note that with the current implementation, parsing is greedy, so whenever multiple parses would apply, the rule starting the earliest and parsing the most tokens wins. For example if you have these rules: 

  a -> x
  a b -> y
  b c d -> z
Then input a b c d e parses to y b c d, ie the 2nd rule "wins" because it started earliest and matched the most input tokens of other rules starting at that point.

A future improvement to this filter could allow non-greedy parsing, such that the 3rd rule would win, and also separately allow multiple parses, such that all 3 rules would match, perhaps even on a rule by rule basis.

NOTE: when a match occurs, the output tokens associated with the matching rule are "stacked" on top of the input stream (if the rule had keepOrig=true) and also on top of another matched rule's output tokens. This is not a correct solution, as really the output should be an arbitrary graph/lattice. For example, with the above match, you would expect an exact PhraseQuery "y b c" to match the parsed tokens, but it will fail to do so. This limitation is necessary because Lucene's TokenStream (and index) cannot yet represent an arbitrary graph.

NOTE: If multiple incoming tokens arrive on the same position, only the first token at that position is used for parsing. Subsequent tokens simply pass through and are not parsed. A future improvement would be to allow these tokens to also be matched.

Inheritance
System.Object
AttributeSource
TokenStream
TokenFilter
SynonymFilter
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Lucene.Net.Analysis.Synonym
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
public sealed class SynonymFilter : TokenFilter, IDisposable

Constructors

| Improve this Doc View Source

SynonymFilter(TokenStream, SynonymMap, Boolean)

Declaration
public SynonymFilter(TokenStream input, SynonymMap synonyms, bool ignoreCase)
Parameters
Type Name Description
TokenStream input

input tokenstream

SynonymMap synonyms

synonym map

System.Boolean ignoreCase

case-folds input for matching with J2N.Character.ToLower(System.Int32). Note, if you set this to true, its your responsibility to lowercase the input entries when you create the SynonymMap

Fields

| Improve this Doc View Source

TYPE_SYNONYM

Declaration
public const string TYPE_SYNONYM = "SYNONYM"
Field Value
Type Description
System.String

Methods

| Improve this Doc View Source

IncrementToken()

Declaration
public override bool IncrementToken()
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

Reset()

Declaration
public override void Reset()
Overrides

Implements

System.IDisposable