C# Class Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase

Base class for decomposition token filters.

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.
  • As of 4.4, CompoundWordTokenFilterBase doesn't update offsets.

Inheritance: TokenFilter
显示文件 Open project: apache/lucenenet Class Usage Examples

Protected Properties

Property Type Description
dictionary CharArraySet
matchVersion LuceneVersion
maxSubwordSize int
minSubwordSize int
minWordSize int
offsetAtt IOffsetAttribute
onlyLongestMatch bool
termAtt ICharTermAttribute
tokens LinkedList

Public Methods

Method Description
IncrementToken ( ) : bool
Reset ( ) : void

Protected Methods

Method Description
CompoundWordTokenFilterBase ( LuceneVersion matchVersion, TokenStream input, CharArraySet dictionary ) : Lucene.Net.Analysis.Tokenattributes
CompoundWordTokenFilterBase ( LuceneVersion matchVersion, TokenStream input, CharArraySet dictionary, bool onlyLongestMatch ) : Lucene.Net.Analysis.Tokenattributes
CompoundWordTokenFilterBase ( LuceneVersion matchVersion, TokenStream input, CharArraySet dictionary, int minWordSize, int minSubwordSize, int maxSubwordSize, bool onlyLongestMatch ) : Lucene.Net.Analysis.Tokenattributes
Decompose ( ) : void

Decomposes the current #termAtt and places CompoundToken instances in the #tokens list. The original token may not be placed in the list, as it is automatically passed through this filter.

Method Details

CompoundWordTokenFilterBase() protected method

protected CompoundWordTokenFilterBase ( LuceneVersion matchVersion, TokenStream input, CharArraySet dictionary ) : Lucene.Net.Analysis.Tokenattributes
matchVersion LuceneVersion
input TokenStream
dictionary CharArraySet
return Lucene.Net.Analysis.Tokenattributes

CompoundWordTokenFilterBase() protected method

protected CompoundWordTokenFilterBase ( LuceneVersion matchVersion, TokenStream input, CharArraySet dictionary, bool onlyLongestMatch ) : Lucene.Net.Analysis.Tokenattributes
matchVersion LuceneVersion
input TokenStream
dictionary CharArraySet
onlyLongestMatch bool
return Lucene.Net.Analysis.Tokenattributes

CompoundWordTokenFilterBase() protected method

protected CompoundWordTokenFilterBase ( LuceneVersion matchVersion, TokenStream input, CharArraySet dictionary, int minWordSize, int minSubwordSize, int maxSubwordSize, bool onlyLongestMatch ) : Lucene.Net.Analysis.Tokenattributes
matchVersion LuceneVersion
input TokenStream
dictionary CharArraySet
minWordSize int
minSubwordSize int
maxSubwordSize int
onlyLongestMatch bool
return Lucene.Net.Analysis.Tokenattributes

Decompose() protected abstract method

Decomposes the current #termAtt and places CompoundToken instances in the #tokens list. The original token may not be placed in the list, as it is automatically passed through this filter.
protected abstract Decompose ( ) : void
return void

IncrementToken() public final method

public final IncrementToken ( ) : bool
return bool

Reset() public method

public Reset ( ) : void
return void

Property Details

dictionary protected_oe property

protected CharArraySet dictionary
return CharArraySet

matchVersion protected_oe property

protected LuceneVersion matchVersion
return LuceneVersion

maxSubwordSize protected_oe property

protected int maxSubwordSize
return int

minSubwordSize protected_oe property

protected int minSubwordSize
return int

minWordSize protected_oe property

protected int minWordSize
return int

offsetAtt protected_oe property

protected IOffsetAttribute offsetAtt
return IOffsetAttribute

onlyLongestMatch protected_oe property

protected bool onlyLongestMatch
return bool

termAtt protected_oe property

protected ICharTermAttribute termAtt
return ICharTermAttribute

tokens protected_oe property

protected LinkedList tokens
return LinkedList