Class PrefixAwareTokenFilter

Joins two token streams and leaves the last token of the first stream available to be used when updating the token values in the second stream based on that token.

The default implementation adds last prefix token end offset to the suffix token start and end offsets.

NOTE: This filter might not behave correctly if used with custom IAttributes, i.e. IAttributes other than the ones located in Lucene.Net.Analysis.TokenAttributes.

Inheritance
System.Object
Lucene.Net.Util.AttributeSource
Lucene.Net.Analysis.TokenStream
PrefixAwareTokenFilter
Implements
System.IDisposable
Inherited Members
Lucene.Net.Analysis.TokenStream.Dispose()
Lucene.Net.Util.AttributeSource.GetAttributeFactory()
Lucene.Net.Util.AttributeSource.GetAttributeClassesEnumerator()
Lucene.Net.Util.AttributeSource.GetAttributeImplsEnumerator()
Lucene.Net.Util.AttributeSource.AddAttributeImpl(Lucene.Net.Util.Attribute)
Lucene.Net.Util.AttributeSource.AddAttribute<T>()
Lucene.Net.Util.AttributeSource.HasAttributes
Lucene.Net.Util.AttributeSource.HasAttribute<T>()
Lucene.Net.Util.AttributeSource.GetAttribute<T>()
Lucene.Net.Util.AttributeSource.ClearAttributes()
Lucene.Net.Util.AttributeSource.CaptureState()
Lucene.Net.Util.AttributeSource.RestoreState(Lucene.Net.Util.AttributeSource.State)
Lucene.Net.Util.AttributeSource.GetHashCode()
Lucene.Net.Util.AttributeSource.ReflectWith(Lucene.Net.Util.IAttributeReflector)
Lucene.Net.Util.AttributeSource.CloneAttributes()
Lucene.Net.Util.AttributeSource.CopyTo(Lucene.Net.Util.AttributeSource)
Lucene.Net.Util.AttributeSource.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Lucene.Net.Analysis.Miscellaneous
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
public class PrefixAwareTokenFilter : TokenStream, IDisposable

Constructors

| Improve this Doc View Source

PrefixAwareTokenFilter(TokenStream, TokenStream)

Declaration
public PrefixAwareTokenFilter(TokenStream prefix, TokenStream suffix)
Parameters
Type Name Description
Lucene.Net.Analysis.TokenStream prefix
Lucene.Net.Analysis.TokenStream suffix

Properties

| Improve this Doc View Source

Prefix

Declaration
public virtual TokenStream Prefix { get; set; }
Property Value
Type Description
Lucene.Net.Analysis.TokenStream
| Improve this Doc View Source

Suffix

Declaration
public virtual TokenStream Suffix { get; set; }
Property Value
Type Description
Lucene.Net.Analysis.TokenStream

Methods

| Improve this Doc View Source

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
Overrides
| Improve this Doc View Source

End()

Declaration
public override void End()
Overrides
Lucene.Net.Analysis.TokenStream.End()
| Improve this Doc View Source

IncrementToken()

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

Reset()

Declaration
public override void Reset()
Overrides
Lucene.Net.Analysis.TokenStream.Reset()
| Improve this Doc View Source

UpdateSuffixToken(Token, Token)

The default implementation adds last prefix token end offset to the suffix token start and end offsets.

Declaration
public virtual Token UpdateSuffixToken(Token suffixToken, Token lastPrefixToken)
Parameters
Type Name Description
Lucene.Net.Analysis.Token suffixToken

a token from the suffix stream

Lucene.Net.Analysis.Token lastPrefixToken

the last token from the prefix stream

Returns
Type Description
Lucene.Net.Analysis.Token

consumer token

Implements

System.IDisposable