• API

    Show / Hide Table of Contents

    Class Lucene40StoredFieldsReader

    Class responsible for access to stored document fields.

    It uses <segment>.fdt and <segment>.fdx; files.

    This is a Lucene.NET INTERNAL API, use at your own risk
    Inheritance
    System.Object
    StoredFieldsReader
    Lucene40StoredFieldsReader
    Implements
    System.IDisposable
    Inherited Members
    StoredFieldsReader.Dispose()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Lucene.Net.Codecs.Lucene40
    Assembly: Lucene.Net.dll
    Syntax
    public sealed class Lucene40StoredFieldsReader : StoredFieldsReader, IDisposable

    Constructors

    | Improve this Doc View Source

    Lucene40StoredFieldsReader(Directory, SegmentInfo, FieldInfos, IOContext)

    Sole constructor.

    Declaration
    public Lucene40StoredFieldsReader(Directory d, SegmentInfo si, FieldInfos fn, IOContext context)
    Parameters
    Type Name Description
    Directory d
    SegmentInfo si
    FieldInfos fn
    IOContext context

    Properties

    | Improve this Doc View Source

    Count

    Returns number of documents.

    NOTE: This was size() in Lucene.

    Declaration
    public int Count { get; }
    Property Value
    Type Description
    System.Int32

    Methods

    | Improve this Doc View Source

    CheckIntegrity()

    Declaration
    public override void CheckIntegrity()
    Overrides
    StoredFieldsReader.CheckIntegrity()
    | Improve this Doc View Source

    Clone()

    Returns a cloned FieldsReader that shares open IndexInputs with the original one. It is the caller's job not to dispose the original FieldsReader until all clones are called (eg, currently SegmentReader manages this logic).

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

    Dispose(Boolean)

    Closes the underlying IndexInput streams. This means that the Fields values will not be accessible.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing
    Overrides
    StoredFieldsReader.Dispose(Boolean)
    Exceptions
    Type Condition
    System.IO.IOException

    If an I/O error occurs.

    | Improve this Doc View Source

    RamBytesUsed()

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

    RawDocs(Int32[], Int32, Int32)

    Returns the length in bytes of each raw document in a contiguous range of length numDocs starting with startDocID. Returns the IndexInput (the fieldStream), already seeked to the starting point for startDocID.

    Declaration
    public IndexInput RawDocs(int[] lengths, int startDocID, int numDocs)
    Parameters
    Type Name Description
    System.Int32[] lengths
    System.Int32 startDocID
    System.Int32 numDocs
    Returns
    Type Description
    IndexInput
    | Improve this Doc View Source

    VisitDocument(Int32, StoredFieldVisitor)

    Declaration
    public override void VisitDocument(int n, StoredFieldVisitor visitor)
    Parameters
    Type Name Description
    System.Int32 n
    StoredFieldVisitor visitor
    Overrides
    StoredFieldsReader.VisitDocument(Int32, StoredFieldVisitor)

    Implements

    System.IDisposable

    See Also

    Lucene40StoredFieldsFormat
    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 Licensed to the Apache Software Foundation (ASF)