Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class Lucene40StoredFieldsReader

    Class responsible for access to stored document fields.

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

    Note

    This API is for internal purposes only and might change in incompatible ways in the next release.

    Inheritance
    object
    StoredFieldsReader
    Lucene40StoredFieldsReader
    Implements
    IDisposable
    Inherited Members
    StoredFieldsReader.Dispose()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Codecs.Lucene40
    Assembly: Lucene.Net.dll
    Syntax
    public sealed class Lucene40StoredFieldsReader : StoredFieldsReader, IDisposable

    Constructors

    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
    See Also
    Lucene40StoredFieldsFormat

    Properties

    Count

    Returns number of documents.

    NOTE: This was size() in Lucene.
    Declaration
    public int Count { get; }
    Property Value
    Type Description
    int
    See Also
    Lucene40StoredFieldsFormat

    Methods

    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.

    Note

    This API is for internal purposes only and might change in incompatible ways in the next release.

    Declaration
    public override void CheckIntegrity()
    Overrides
    StoredFieldsReader.CheckIntegrity()
    See Also
    Lucene40StoredFieldsFormat

    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
    object
    Overrides
    StoredFieldsReader.Clone()
    See Also
    Lucene40StoredFieldsFormat

    Dispose(bool)

    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
    bool disposing
    Overrides
    StoredFieldsReader.Dispose(bool)
    Exceptions
    Type Condition
    IOException

    If an I/O error occurs.

    See Also
    Lucene40StoredFieldsFormat

    RamBytesUsed()

    Returns approximate RAM bytes used.

    Declaration
    public override long RamBytesUsed()
    Returns
    Type Description
    long
    Overrides
    StoredFieldsReader.RamBytesUsed()
    See Also
    Lucene40StoredFieldsFormat

    RawDocs(int[], int, int)

    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
    int[] lengths
    int startDocID
    int numDocs
    Returns
    Type Description
    IndexInput
    See Also
    Lucene40StoredFieldsFormat

    VisitDocument(int, StoredFieldVisitor)

    Visit the stored fields for document n.

    Declaration
    public override void VisitDocument(int n, StoredFieldVisitor visitor)
    Parameters
    Type Name Description
    int n
    StoredFieldVisitor visitor
    Overrides
    StoredFieldsReader.VisitDocument(int, StoredFieldVisitor)
    See Also
    Lucene40StoredFieldsFormat

    Implements

    IDisposable

    See Also

    Lucene40StoredFieldsFormat
    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.