Show / Hide Table of Contents

    Class StoredFieldsReader

    Codec API for reading stored fields.

    You need to implement VisitDocument(Int32, StoredFieldVisitor) to read the stored fields for a document, implement Clone() (creating clones of any IndexInputs used, etc), and Dispose(Boolean) to cleanup any allocated resources.

    This is a Lucene.NET EXPERIMENTAL API, use at your own risk
    Inheritance
    System.Object
    StoredFieldsReader
    CompressingStoredFieldsReader
    Lucene40StoredFieldsReader
    Namespace: Lucene.Net.Codecs
    Assembly: Lucene.Net.dll
    Syntax
    public abstract class StoredFieldsReader : IDisposable

    Constructors

    | Improve this Doc View Source

    StoredFieldsReader()

    Sole constructor. (For invocation by subclass constructors, typically implicit.)

    Declaration
    protected StoredFieldsReader()

    Methods

    | Improve this Doc View Source

    CheckIntegrity()

    Checks consistency of this reader.

    Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.

    This is a Lucene.NET INTERNAL API, use at your own risk
    Declaration
    public abstract void CheckIntegrity()
    | Improve this Doc View Source

    Clone()

    Declaration
    public abstract object Clone()
    Returns
    Type Description
    System.Object
    | Improve this Doc View Source

    Dispose()

    Disposes all resources used by this object.

    Declaration
    public void Dispose()
    | Improve this Doc View Source

    Dispose(Boolean)

    Implementations must override and should dispose all resources used by this instance.

    Declaration
    protected abstract void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing
    | Improve this Doc View Source

    RamBytesUsed()

    Returns approximate RAM bytes used.

    Declaration
    public abstract long RamBytesUsed()
    Returns
    Type Description
    System.Int64
    | Improve this Doc View Source

    VisitDocument(Int32, StoredFieldVisitor)

    Visit the stored fields for document n.

    Declaration
    public abstract void VisitDocument(int n, StoredFieldVisitor visitor)
    Parameters
    Type Name Description
    System.Int32 n
    StoredFieldVisitor visitor
    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 Licensed to the Apache Software Foundation (ASF)