Fork me on GitHub
  • API

    Show / Hide Table of Contents

    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 work

    Inheritance
    System.Object
    Lucene.Net.Util.AttributeSource
    Lucene.Net.Analysis.TokenStream
    Lucene.Net.Analysis.TokenFilter
    DelimitedPayloadTokenFilter
    Implements
    System.IDisposable
    Inherited Members
    Lucene.Net.Analysis.TokenFilter.m_input
    Lucene.Net.Analysis.TokenFilter.End()
    TokenFilter.Dispose(Boolean)
    Lucene.Net.Analysis.TokenFilter.Reset()
    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()
    AttributeSource.Equals(Object)
    AttributeSource.ReflectAsString(Boolean)
    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.Payloads
    Assembly: Lucene.Net.Analysis.Common.dll
    Syntax
    public sealed class DelimitedPayloadTokenFilter : TokenFilter, IDisposable

    Constructors

    | Improve this Doc View Source

    DelimitedPayloadTokenFilter(TokenStream, Char, IPayloadEncoder)

    Declaration
    public DelimitedPayloadTokenFilter(TokenStream input, char delimiter, IPayloadEncoder encoder)
    Parameters
    Type Name Description
    Lucene.Net.Analysis.TokenStream input
    System.Char delimiter
    IPayloadEncoder encoder

    Fields

    | Improve this Doc View Source

    DEFAULT_DELIMITER

    Declaration
    public const char DEFAULT_DELIMITER = '|'
    Field Value
    Type Description
    System.Char

    Methods

    | Improve this Doc View Source

    IncrementToken()

    Declaration
    public override bool IncrementToken()
    Returns
    Type Description
    System.Boolean
    Overrides
    Lucene.Net.Analysis.TokenStream.IncrementToken()

    Implements

    System.IDisposable

    See Also

    IPayloadEncoder
    • Improve this Doc
    • View Source
    In This Article
    • Constructors
      • DelimitedPayloadTokenFilter(TokenStream, Char, IPayloadEncoder)
    • Fields
      • DEFAULT_DELIMITER
    • Methods
      • IncrementToken()
    • Implements
    • See Also
    Back to top Copyright © 2020 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.