Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class Lucene45DocValuesProducer

    Reader for Lucene45DocValuesFormat.

    Inheritance
    object
    DocValuesProducer
    Lucene45DocValuesProducer
    Implements
    IDisposable
    Inherited Members
    DocValuesProducer.Dispose()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Codecs.Lucene45
    Assembly: Lucene.Net.dll
    Syntax
    public class Lucene45DocValuesProducer : DocValuesProducer, IDisposable

    Constructors

    Lucene45DocValuesProducer(SegmentReadState, string, string, string, string)

    Expert: instantiates a new reader.

    Declaration
    protected Lucene45DocValuesProducer(SegmentReadState state, string dataCodec, string dataExtension, string metaCodec, string metaExtension)
    Parameters
    Type Name Description
    SegmentReadState state
    string dataCodec
    string dataExtension
    string metaCodec
    string metaExtension

    Methods

    CheckIntegrity()

    Checks consistency of this producer.

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

    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
    DocValuesProducer.Dispose(bool)

    GetAddressInstance(IndexInput, FieldInfo, BinaryEntry)

    Returns an address instance for variable-length binary values.

    Note

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

    Declaration
    protected virtual MonotonicBlockPackedReader GetAddressInstance(IndexInput data, FieldInfo field, Lucene45DocValuesProducer.BinaryEntry bytes)
    Parameters
    Type Name Description
    IndexInput data
    FieldInfo field
    Lucene45DocValuesProducer.BinaryEntry bytes
    Returns
    Type Description
    MonotonicBlockPackedReader

    GetBinary(FieldInfo)

    Returns BinaryDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

    Declaration
    public override BinaryDocValues GetBinary(FieldInfo field)
    Parameters
    Type Name Description
    FieldInfo field
    Returns
    Type Description
    BinaryDocValues
    Overrides
    DocValuesProducer.GetBinary(FieldInfo)

    GetDocsWithField(FieldInfo)

    Returns a IBits at the size of reader.MaxDoc, with turned on bits for each docid that does have a value for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

    Declaration
    public override IBits GetDocsWithField(FieldInfo field)
    Parameters
    Type Name Description
    FieldInfo field
    Returns
    Type Description
    IBits
    Overrides
    DocValuesProducer.GetDocsWithField(FieldInfo)

    GetIntervalInstance(IndexInput, FieldInfo, BinaryEntry)

    Returns an address instance for prefix-compressed binary values.

    Note

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

    Declaration
    protected virtual MonotonicBlockPackedReader GetIntervalInstance(IndexInput data, FieldInfo field, Lucene45DocValuesProducer.BinaryEntry bytes)
    Parameters
    Type Name Description
    IndexInput data
    FieldInfo field
    Lucene45DocValuesProducer.BinaryEntry bytes
    Returns
    Type Description
    MonotonicBlockPackedReader

    GetNumeric(FieldInfo)

    Returns NumericDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

    Declaration
    public override NumericDocValues GetNumeric(FieldInfo field)
    Parameters
    Type Name Description
    FieldInfo field
    Returns
    Type Description
    NumericDocValues
    Overrides
    DocValuesProducer.GetNumeric(FieldInfo)

    GetOrdIndexInstance(IndexInput, FieldInfo, NumericEntry)

    Returns an address instance for sortedset ordinal lists.

    Note

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

    Declaration
    protected virtual MonotonicBlockPackedReader GetOrdIndexInstance(IndexInput data, FieldInfo field, Lucene45DocValuesProducer.NumericEntry entry)
    Parameters
    Type Name Description
    IndexInput data
    FieldInfo field
    Lucene45DocValuesProducer.NumericEntry entry
    Returns
    Type Description
    MonotonicBlockPackedReader

    GetSorted(FieldInfo)

    Returns SortedDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

    Declaration
    public override SortedDocValues GetSorted(FieldInfo field)
    Parameters
    Type Name Description
    FieldInfo field
    Returns
    Type Description
    SortedDocValues
    Overrides
    DocValuesProducer.GetSorted(FieldInfo)

    GetSortedSet(FieldInfo)

    Returns SortedSetDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

    Declaration
    public override SortedSetDocValues GetSortedSet(FieldInfo field)
    Parameters
    Type Name Description
    FieldInfo field
    Returns
    Type Description
    SortedSetDocValues
    Overrides
    DocValuesProducer.GetSortedSet(FieldInfo)

    RamBytesUsed()

    Returns approximate RAM bytes used.

    Declaration
    public override long RamBytesUsed()
    Returns
    Type Description
    long
    Overrides
    DocValuesProducer.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.