Class CachingTokenFilter

This class can be used if the token attributes of a TokenStream are intended to be consumed more than once. It caches all token attribute states locally in a List.

CachingTokenFilter implements the optional method Reset(), which repositions the stream to the first Token.

Inheritance
System.Object
AttributeSource
TokenStream
TokenFilter
CachingTokenFilter
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
Assembly: Lucene.Net.dll
Syntax
public sealed class CachingTokenFilter : TokenFilter, IDisposable

Constructors

| Improve this Doc View Source

CachingTokenFilter(TokenStream)

Create a new CachingTokenFilter around input, caching its token attributes, which can be replayed again after a call to Reset().

Declaration
public CachingTokenFilter(TokenStream input)
Parameters
Type Name Description
TokenStream input

Methods

| Improve this Doc View Source

Dispose(Boolean)

Releases resources used by the CachingTokenFilter and if overridden in a derived class, optionally releases unmanaged resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides
| Improve this Doc View Source

End()

Declaration
public override void End()
Overrides
| Improve this Doc View Source

IncrementToken()

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

Reset()

Rewinds the iterator to the beginning of the cached list.

Note that this does not call Reset() on the wrapped tokenstream ever, even the first time. You should Reset() the inner tokenstream before wrapping it with CachingTokenFilter.

Declaration
public override void Reset()
Overrides

Implements

System.IDisposable