Class DictionaryCompoundWordTokenFilter

A TokenFilter that decomposes compound words found in many Germanic languages.

"Donaudampfschiff" becomes Donau, dampf, schiff so that you can find "Donaudampfschiff" even when you only enter "schiff". It uses a brute-force algorithm to achieve this.

You must specify the required LuceneVersion compatibility when creating CompoundWordTokenFilterBase:

  • As of 3.1, CompoundWordTokenFilterBase correctly handles Unicode 4.0 supplementary characters in strings and char arrays provided as compound word dictionaries.

Inheritance
System.Object
AttributeSource
TokenStream
TokenFilter
CompoundWordTokenFilterBase
DictionaryCompoundWordTokenFilter
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.Compound
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
public class DictionaryCompoundWordTokenFilter : CompoundWordTokenFilterBase, IDisposable

Constructors

| Improve this Doc View Source

DictionaryCompoundWordTokenFilter(LuceneVersion, TokenStream, CharArraySet)

Creates a new DictionaryCompoundWordTokenFilter

Declaration
public DictionaryCompoundWordTokenFilter(LuceneVersion matchVersion, TokenStream input, CharArraySet dictionary)
Parameters
Type Name Description
LuceneVersion matchVersion

Lucene version to enable correct Unicode 4.0 behavior in the dictionaries if Version > 3.0. See CompoundWordTokenFilterBase for details.

TokenStream input

the TokenStream to process

CharArraySet dictionary

the word dictionary to match against.

| Improve this Doc View Source

DictionaryCompoundWordTokenFilter(LuceneVersion, TokenStream, CharArraySet, Int32, Int32, Int32, Boolean)

Creates a new DictionaryCompoundWordTokenFilter

Declaration
public DictionaryCompoundWordTokenFilter(LuceneVersion matchVersion, TokenStream input, CharArraySet dictionary, int minWordSize, int minSubwordSize, int maxSubwordSize, bool onlyLongestMatch)
Parameters
Type Name Description
LuceneVersion matchVersion

Lucene version to enable correct Unicode 4.0 behavior in the dictionaries if Version > 3.0. See CompoundWordTokenFilterBase for details.

TokenStream input

the TokenStream to process

CharArraySet dictionary

the word dictionary to match against.

System.Int32 minWordSize

only words longer than this get processed

System.Int32 minSubwordSize

only subwords longer than this get to the output stream

System.Int32 maxSubwordSize

only subwords shorter than this get to the output stream

System.Boolean onlyLongestMatch

Add only the longest matching subword to the stream

Methods

| Improve this Doc View Source

Decompose()

Declaration
protected override void Decompose()
Overrides

Implements

System.IDisposable