Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class Lucene47WordDelimiterFilter

    Old Broken version of WordDelimiterFilter

    Inheritance
    object
    AttributeSource
    TokenStream
    TokenFilter
    Lucene47WordDelimiterFilter
    Implements
    IDisposable
    Inherited Members
    TokenFilter.End()
    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.Equals(object)
    AttributeSource.ReflectAsString(bool)
    AttributeSource.ReflectWith(IAttributeReflector)
    AttributeSource.CloneAttributes()
    AttributeSource.CopyTo(AttributeSource)
    AttributeSource.ToString()
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Analysis.Miscellaneous
    Assembly: Lucene.Net.Analysis.Common.dll
    Syntax
    [Obsolete]
    public sealed class Lucene47WordDelimiterFilter : TokenFilter, IDisposable

    Constructors

    Lucene47WordDelimiterFilter(TokenStream, WordDelimiterFlags, CharArraySet)

    Creates a new Lucene47WordDelimiterFilter using DEFAULT_WORD_DELIM_TABLE as its charTypeTable

    Declaration
    public Lucene47WordDelimiterFilter(TokenStream @in, WordDelimiterFlags configurationFlags, CharArraySet protWords)
    Parameters
    Type Name Description
    TokenStream in

    Lucene.Net.Analysis.TokenStream to be filtered

    WordDelimiterFlags configurationFlags

    Flags configuring the filter

    CharArraySet protWords

    If not null is the set of tokens to protect from being delimited

    Lucene47WordDelimiterFilter(TokenStream, byte[], WordDelimiterFlags, CharArraySet)

    Creates a new Lucene47WordDelimiterFilter

    Declaration
    public Lucene47WordDelimiterFilter(TokenStream @in, byte[] charTypeTable, WordDelimiterFlags configurationFlags, CharArraySet protWords)
    Parameters
    Type Name Description
    TokenStream in

    Lucene.Net.Analysis.TokenStream to be filtered

    byte[] charTypeTable

    table containing character types

    WordDelimiterFlags configurationFlags

    Flags configuring the filter

    CharArraySet protWords

    If not null is the set of tokens to protect from being delimited

    Fields

    ALPHA

    Old Broken version of WordDelimiterFilter

    Declaration
    public const int ALPHA = 3
    Field Value
    Type Description
    int

    ALPHANUM

    Old Broken version of WordDelimiterFilter

    Declaration
    public const int ALPHANUM = 7
    Field Value
    Type Description
    int

    DIGIT

    Old Broken version of WordDelimiterFilter

    Declaration
    public const int DIGIT = 4
    Field Value
    Type Description
    int

    LOWER

    Old Broken version of WordDelimiterFilter

    Declaration
    public const int LOWER = 1
    Field Value
    Type Description
    int

    SUBWORD_DELIM

    Old Broken version of WordDelimiterFilter

    Declaration
    public const int SUBWORD_DELIM = 8
    Field Value
    Type Description
    int

    UPPER

    Old Broken version of WordDelimiterFilter

    Declaration
    public const int UPPER = 2
    Field Value
    Type Description
    int

    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()

    Reset()

    This method is called by a consumer before it begins consumption using IncrementToken().

    Resets this stream to a clean state. Stateful implementations must implement this method so that they can be reused, just as if they had been created fresh.

    If you override this method, always call base.Reset(), otherwise some internal state will not be correctly reset (e.g., Lucene.Net.Analysis.Tokenizer will throw InvalidOperationException on further usage).
    Declaration
    public override void Reset()
    Overrides
    Lucene.Net.Analysis.TokenFilter.Reset()
    Remarks

    NOTE: The default implementation chains the call to the input Lucene.Net.Analysis.TokenStream, so be sure to call base.Reset() when overriding this method.

    Implements

    IDisposable
    Back to top Copyright © 2024 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.