Class DelimitedPayloadTokenFilter
Characters before the delimiter are the "token", those after are the payload.
For example, if the delimiter is '|', then for the string "foo|bar", foo is the token and "bar" is a payload. Note, you can also include a IPayloadEncoder to convert the payload in an appropriate way (from characters to bytes). Note make sure your Lucene.Net.Analysis.Tokenizer doesn't split on the delimiter, or this won't workImplements
Inherited Members
TokenFilter.End()
TokenFilter.Reset()
TokenStream.Dispose()
AttributeSource.GetAttributeFactory()
AttributeSource.GetAttributeClassesEnumerator()
AttributeSource.GetAttributeImplsEnumerator()
AttributeSource.AddAttributeImpl(Attribute)
AttributeSource.AddAttribute<T>()
AttributeSource.HasAttributes
AttributeSource.HasAttribute<T>()
AttributeSource.GetAttribute<T>()
AttributeSource.ClearAttributes()
AttributeSource.CaptureState()
AttributeSource.RestoreState(AttributeSource.State)
AttributeSource.GetHashCode()
AttributeSource.ReflectWith(IAttributeReflector)
AttributeSource.CloneAttributes()
AttributeSource.CopyTo(AttributeSource)
AttributeSource.ToString()
Namespace: Lucene.Net.Analysis.Payloads
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
public sealed class DelimitedPayloadTokenFilter : TokenFilter, IDisposableConstructors
DelimitedPayloadTokenFilter(TokenStream, char, IPayloadEncoder)
Characters before the delimiter are the "token", those after are the payload.
For example, if the delimiter is '|', then for the string "foo|bar", foo is the token and "bar" is a payload. Note, you can also include a IPayloadEncoder to convert the payload in an appropriate way (from characters to bytes). Note make sure your Lucene.Net.Analysis.Tokenizer doesn't split on the delimiter, or this won't workDeclaration
public DelimitedPayloadTokenFilter(TokenStream input, char delimiter, IPayloadEncoder encoder)Parameters
| Type | Name | Description |
|---|---|---|
| TokenStream | input | |
| char | delimiter | |
| IPayloadEncoder | encoder |
See Also
Fields
DEFAULT_DELIMITER
Characters before the delimiter are the "token", those after are the payload.
For example, if the delimiter is '|', then for the string "foo|bar", foo is the token and "bar" is a payload. Note, you can also include a IPayloadEncoder to convert the payload in an appropriate way (from characters to bytes). Note make sure your Lucene.Net.Analysis.Tokenizer doesn't split on the delimiter, or this won't workDeclaration
public const char DEFAULT_DELIMITER = '|'Field Value
| Type | Description |
|---|---|
| char |
See Also
Methods
IncrementToken()
Consumers (i.e., Lucene.Net.Index.IndexWriter) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriate Lucene.Net.Util.IAttributes with the attributes of the next token.
The producer must make no assumptions about the attributes after the method has been returned: the caller may arbitrarily change it. If the producer needs to preserve the state for subsequent calls, it can use Lucene.Net.Util.AttributeSource.CaptureState() to create a copy of the current attribute state. this method is called for every token of a document, so an efficient implementation is crucial for good performance. To avoid calls to Lucene.Net.Util.AttributeSource.AddAttribute<T>() and Lucene.Net.Util.AttributeSource.GetAttribute<T>(), references to all Lucene.Net.Util.IAttributes that this stream uses should be retrieved during instantiation. To ensure that filters and consumers know which attributes are available, the attributes must be added during instantiation. Filters and consumers are not required to check for availability of attributes in Lucene.Net.Analysis.TokenStream.IncrementToken().Declaration
public override bool IncrementToken()Returns
| Type | Description |
|---|---|
| bool | false for end of stream; true otherwise |
Overrides
Lucene.Net.Analysis.TokenStream.IncrementToken()