C# Class Lucene.Net.Analysis.Util.FilteringTokenFilter

Abstract base class for TokenFilters that may remove tokens. You have to implement #accept and return a boolean if the current token should be preserved. #incrementToken uses this method to decide if a token should be passed to the caller.

As of Lucene 4.4, an IllegalArgumentException is thrown when trying to disable position increments when filtering terms.

Inheritance: TokenFilter
Show file Open project: paulirwin/lucene.net

Protected Properties

Property Type Description
version Lucene.Net.Util.Version

Public Methods

Method Description
End ( ) : void
FilteringTokenFilter ( Lucene.Net.Util.Version version, TokenStream @in ) : System

Create a new FilteringTokenFilter.
IncrementToken ( ) : bool
Reset ( ) : void

Protected Methods

Method Description
Accept ( ) : bool

Override this method and return if the current input token should be returned by #incrementToken.

Private Methods

Method Description
CheckPositionIncrement ( Lucene.Net.Util.Version version, bool enablePositionIncrements ) : void
FilteringTokenFilter ( Lucene.Net.Util.Version version, bool enablePositionIncrements, TokenStream input ) : System

Method Details

Accept() protected abstract method

Override this method and return if the current input token should be returned by #incrementToken.
protected abstract Accept ( ) : bool
return bool

End() public method

public End ( ) : void
return void

FilteringTokenFilter() public method

Create a new FilteringTokenFilter.
public FilteringTokenFilter ( Lucene.Net.Util.Version version, TokenStream @in ) : System
version Lucene.Net.Util.Version the Lucene match version
@in TokenStream
return System

IncrementToken() public method

public IncrementToken ( ) : bool
return bool

Reset() public method

public Reset ( ) : void
return void

Property Details

version protected property

protected Version,Lucene.Net.Util version
return Lucene.Net.Util.Version