Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class MockCharFilter

    The purpose of this charfilter is to send offsets out of bounds if the analyzer doesn't use CorrectOffset(int) or does incorrect offset math.

    Inheritance
    object
    MarshalByRefObject
    TextReader
    CharFilter
    MockCharFilter
    Implements
    IDisposable
    Inherited Members
    CharFilter.m_input
    CharFilter.Dispose(bool)
    CharFilter.CorrectOffset(int)
    CharFilter.Skip(int)
    CharFilter.Reset()
    CharFilter.IsReady
    CharFilter.IsMarkSupported
    CharFilter.Mark(int)
    TextReader.Null
    TextReader.Close()
    TextReader.Dispose()
    TextReader.Peek()
    TextReader.Read(Span<char>)
    TextReader.ReadAsync(char[], int, int)
    TextReader.ReadAsync(Memory<char>, CancellationToken)
    TextReader.ReadBlock(char[], int, int)
    TextReader.ReadBlock(Span<char>)
    TextReader.ReadBlockAsync(char[], int, int)
    TextReader.ReadBlockAsync(Memory<char>, CancellationToken)
    TextReader.ReadLine()
    TextReader.ReadLineAsync()
    TextReader.ReadLineAsync(CancellationToken)
    TextReader.ReadToEnd()
    TextReader.ReadToEndAsync()
    TextReader.ReadToEndAsync(CancellationToken)
    TextReader.Synchronized(TextReader)
    MarshalByRefObject.GetLifetimeService()
    MarshalByRefObject.InitializeLifetimeService()
    MarshalByRefObject.MemberwiseClone(bool)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Analysis
    Assembly: Lucene.Net.TestFramework.dll
    Syntax
    public class MockCharFilter : CharFilter, IDisposable

    Constructors

    MockCharFilter(TextReader)

    The purpose of this charfilter is to send offsets out of bounds if the analyzer doesn't use CorrectOffset(int) or does incorrect offset math.

    Declaration
    public MockCharFilter(TextReader @in)
    Parameters
    Type Name Description
    TextReader in

    MockCharFilter(TextReader, int)

    The purpose of this charfilter is to send offsets out of bounds if the analyzer doesn't use CorrectOffset(int) or does incorrect offset math.

    Declaration
    public MockCharFilter(TextReader @in, int remainder)
    Parameters
    Type Name Description
    TextReader in
    int remainder

    Methods

    AddOffCorrectMap(int, int)

    The purpose of this charfilter is to send offsets out of bounds if the analyzer doesn't use CorrectOffset(int) or does incorrect offset math.

    Declaration
    protected virtual void AddOffCorrectMap(int off, int cumulativeDiff)
    Parameters
    Type Name Description
    int off
    int cumulativeDiff

    Correct(int)

    Subclasses override to correct the current offset.

    Declaration
    protected override int Correct(int currentOff)
    Parameters
    Type Name Description
    int currentOff

    current offset

    Returns
    Type Description
    int

    corrected offset

    Overrides
    CharFilter.Correct(int)

    Read()

    Reads the next character from the text reader and advances the character position by one character.

    Declaration
    public override int Read()
    Returns
    Type Description
    int

    The next character from the text reader, or -1 if no more characters are available. The default implementation returns -1.

    Overrides
    Lucene.Net.Analysis.CharFilter.Read()
    Exceptions
    Type Condition
    ObjectDisposedException

    The TextReader is closed.

    IOException

    An I/O error occurs.

    Read(char[], int, int)

    Reads a specified maximum number of characters from the current reader and writes the data to a buffer, beginning at the specified index.

    Declaration
    public override int Read(char[] cbuf, int off, int len)
    Parameters
    Type Name Description
    char[] cbuf
    int off
    int len
    Returns
    Type Description
    int

    The number of characters that have been read. The number will be less than or equal to count, depending on whether the data is available within the reader. This method returns 0 (zero) if it is called when no more characters are left to read.

    Overrides
    CharFilter.Read(char[], int, int)
    Exceptions
    Type Condition
    ArgumentNullException

    buffer is null.

    ArgumentException

    The buffer length minus index is less than count.

    ArgumentOutOfRangeException

    index or count is negative.

    ObjectDisposedException

    The TextReader is closed.

    IOException

    An I/O error occurs.

    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.