Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class TermsIndexReaderBase

    BlockTermsReader interacts with an instance of this class to manage its terms index. The writer must accept indexed terms (many pairs of Lucene.Net.Util.BytesRef text + long fileOffset), and then this reader must be able to retrieve the nearest index term to a provided term text.

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Inheritance
    object
    TermsIndexReaderBase
    FixedGapTermsIndexReader
    VariableGapTermsIndexReader
    Implements
    IDisposable
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Codecs.BlockTerms
    Assembly: Lucene.Net.Codecs.dll
    Syntax
    public abstract class TermsIndexReaderBase : IDisposable

    Properties

    Divisor

    BlockTermsReader interacts with an instance of this class to manage its terms index. The writer must accept indexed terms (many pairs of Lucene.Net.Util.BytesRef text + long fileOffset), and then this reader must be able to retrieve the nearest index term to a provided term text.

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Declaration
    public abstract int Divisor { get; }
    Property Value
    Type Description
    int

    SupportsOrd

    BlockTermsReader interacts with an instance of this class to manage its terms index. The writer must accept indexed terms (many pairs of Lucene.Net.Util.BytesRef text + long fileOffset), and then this reader must be able to retrieve the nearest index term to a provided term text.

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Declaration
    public abstract bool SupportsOrd { get; }
    Property Value
    Type Description
    bool

    Methods

    Dispose()

    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

    Declaration
    public void Dispose()

    Dispose(bool)

    BlockTermsReader interacts with an instance of this class to manage its terms index. The writer must accept indexed terms (many pairs of Lucene.Net.Util.BytesRef text + long fileOffset), and then this reader must be able to retrieve the nearest index term to a provided term text.

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Declaration
    protected abstract void Dispose(bool disposing)
    Parameters
    Type Name Description
    bool disposing

    GetFieldEnum(FieldInfo)

    BlockTermsReader interacts with an instance of this class to manage its terms index. The writer must accept indexed terms (many pairs of Lucene.Net.Util.BytesRef text + long fileOffset), and then this reader must be able to retrieve the nearest index term to a provided term text.

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Declaration
    public abstract TermsIndexReaderBase.FieldIndexEnum GetFieldEnum(FieldInfo fieldInfo)
    Parameters
    Type Name Description
    FieldInfo fieldInfo
    Returns
    Type Description
    TermsIndexReaderBase.FieldIndexEnum

    RamBytesUsed()

    Returns approximate RAM bytes used.

    Declaration
    public abstract long RamBytesUsed()
    Returns
    Type Description
    long

    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.