Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class CompressingTermVectorsReader

    TermVectorsReader for CompressingTermVectorsFormat.

    Note

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

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

    Constructors

    CompressingTermVectorsReader(Directory, SegmentInfo, string, FieldInfos, IOContext, string, CompressionMode)

    Sole constructor.

    Declaration
    public CompressingTermVectorsReader(Directory d, SegmentInfo si, string segmentSuffix, FieldInfos fn, IOContext context, string formatName, CompressionMode compressionMode)
    Parameters
    Type Name Description
    Directory d
    SegmentInfo si
    string segmentSuffix
    FieldInfos fn
    IOContext context
    string formatName
    CompressionMode compressionMode

    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
    TermVectorsReader.CheckIntegrity()

    Clone()

    Create a clone that one caller at a time may use to read term vectors.

    Declaration
    public override object Clone()
    Returns
    Type Description
    object
    Overrides
    TermVectorsReader.Clone()

    Dispose(bool)

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

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    bool disposing
    Overrides
    TermVectorsReader.Dispose(bool)

    Get(int)

    Returns term vectors for this document, or null if term vectors were not indexed. If offsets are available they are in an IOffsetAttribute available from the DocsAndPositionsEnum.

    Declaration
    public override Fields Get(int doc)
    Parameters
    Type Name Description
    int doc
    Returns
    Type Description
    Fields
    Overrides
    TermVectorsReader.Get(int)

    RamBytesUsed()

    Returns approximate RAM bytes used.

    Declaration
    public override long RamBytesUsed()
    Returns
    Type Description
    long
    Overrides
    TermVectorsReader.RamBytesUsed()

    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.