Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class AssertingAtomicReader

    A Lucene.Net.Index.FilterAtomicReader that can be used to apply additional checks for tests.

    Inheritance
    object
    IndexReader
    AtomicReader
    FilterAtomicReader
    AssertingAtomicReader
    Implements
    IDisposable
    Inherited Members
    FilterAtomicReader.Unwrap(AtomicReader)
    FilterAtomicReader.m_input
    FilterAtomicReader.FieldInfos
    FilterAtomicReader.NumDocs
    FilterAtomicReader.MaxDoc
    FilterAtomicReader.Document(int, StoredFieldVisitor)
    FilterAtomicReader.DoClose()
    FilterAtomicReader.ToString()
    FilterAtomicReader.CheckIntegrity()
    AtomicReader.Context
    AtomicReader.AtomicContext
    AtomicReader.HasNorms(string)
    AtomicReader.DocFreq(Term)
    AtomicReader.TotalTermFreq(Term)
    AtomicReader.GetSumDocFreq(string)
    AtomicReader.GetDocCount(string)
    AtomicReader.GetSumTotalTermFreq(string)
    AtomicReader.GetTerms(string)
    AtomicReader.GetTermDocsEnum(Term)
    AtomicReader.GetTermPositionsEnum(Term)
    IndexReader.AddReaderDisposedListener(IReaderDisposedListener)
    IndexReader.RemoveReaderDisposedListener(IReaderDisposedListener)
    IndexReader.RegisterParentReader(IndexReader)
    IndexReader.RefCount
    IndexReader.IncRef()
    IndexReader.TryIncRef()
    IndexReader.DecRef()
    IndexReader.EnsureOpen()
    IndexReader.Equals(object)
    IndexReader.GetHashCode()
    IndexReader.Open(Directory)
    IndexReader.Open(Directory, int)
    IndexReader.Open(IndexWriter, bool)
    IndexReader.Open(IndexCommit)
    IndexReader.Open(IndexCommit, int)
    IndexReader.GetTermVector(int, string)
    IndexReader.NumDeletedDocs
    IndexReader.Document(int)
    IndexReader.Document(int, ISet<string>)
    IndexReader.HasDeletions
    IndexReader.Dispose()
    IndexReader.Dispose(bool)
    IndexReader.Leaves
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Index
    Assembly: Lucene.Net.TestFramework.dll
    Syntax
    public class AssertingAtomicReader : FilterAtomicReader, IDisposable

    Constructors

    AssertingAtomicReader(AtomicReader)

    A Lucene.Net.Index.FilterAtomicReader that can be used to apply additional checks for tests.

    Declaration
    public AssertingAtomicReader(AtomicReader @in)
    Parameters
    Type Name Description
    AtomicReader in

    Properties

    CombinedCoreAndDeletesKey

    Expert: Returns a key for this Lucene.Net.Index.IndexReader that also includes deletions, so Lucene.Net.Search.IFieldCache/Lucene.Net.Search.CachingWrapperFilter can find it again. This key must not have Equals()/GetHashCode() methods, so "equals" means "identical".

    Declaration
    public override object CombinedCoreAndDeletesKey { get; }
    Property Value
    Type Description
    object
    Overrides
    Lucene.Net.Index.IndexReader.CombinedCoreAndDeletesKey

    CoreCacheKey

    Expert: Returns a key for this Lucene.Net.Index.IndexReader, so Lucene.Net.Search.FieldCache/Lucene.Net.Search.CachingWrapperFilter can find it again. This key must not have Equals()/GetHashCode() methods, so "equals" means "identical".

    Declaration
    public override object CoreCacheKey { get; }
    Property Value
    Type Description
    object
    Overrides
    Lucene.Net.Index.IndexReader.CoreCacheKey

    Fields

    Returns Lucene.Net.Index.Fields for this reader. this property may return null if the reader has no postings.

    Declaration
    public override Fields Fields { get; }
    Property Value
    Type Description
    Fields
    Overrides
    Lucene.Net.Index.FilterAtomicReader.Fields

    LiveDocs

    Returns the Lucene.Net.Util.IBits representing live (not deleted) docs. A set bit indicates the doc ID has not been deleted. If this method returns null it means there are no deleted documents (all documents are live).

    The returned instance has been safely published for use by multiple threads without additional synchronization.
    Declaration
    public override IBits LiveDocs { get; }
    Property Value
    Type Description
    IBits
    Overrides
    Lucene.Net.Index.FilterAtomicReader.LiveDocs

    Methods

    GetBinaryDocValues(string)

    Returns Lucene.Net.Index.BinaryDocValues for this field, or null if no Lucene.Net.Index.BinaryDocValues were indexed for this field. The returned instance should only be used by a single thread.

    Declaration
    public override BinaryDocValues GetBinaryDocValues(string field)
    Parameters
    Type Name Description
    string field
    Returns
    Type Description
    BinaryDocValues
    Overrides
    FilterAtomicReader.GetBinaryDocValues(string)

    GetDocsWithField(string)

    Returns a Lucene.Net.Util.IBits at the size of reader.MaxDoc, with turned on bits for each docid that does have a value for this field, or null if no Lucene.Net.Index.DocValues were indexed for this field. The returned instance should only be used by a single thread.

    Declaration
    public override IBits GetDocsWithField(string field)
    Parameters
    Type Name Description
    string field
    Returns
    Type Description
    IBits
    Overrides
    FilterAtomicReader.GetDocsWithField(string)

    GetNormValues(string)

    Returns Lucene.Net.Index.NumericDocValues representing norms for this field, or null if no Lucene.Net.Index.NumericDocValues were indexed. The returned instance should only be used by a single thread.

    Declaration
    public override NumericDocValues GetNormValues(string field)
    Parameters
    Type Name Description
    string field
    Returns
    Type Description
    NumericDocValues
    Overrides
    FilterAtomicReader.GetNormValues(string)

    GetNumericDocValues(string)

    Returns Lucene.Net.Index.NumericDocValues for this field, or null if no Lucene.Net.Index.NumericDocValues were indexed for this field. The returned instance should only be used by a single thread.

    Declaration
    public override NumericDocValues GetNumericDocValues(string field)
    Parameters
    Type Name Description
    string field
    Returns
    Type Description
    NumericDocValues
    Overrides
    FilterAtomicReader.GetNumericDocValues(string)

    GetSortedDocValues(string)

    Returns Lucene.Net.Index.SortedDocValues for this field, or null if no Lucene.Net.Index.SortedDocValues were indexed for this field. The returned instance should only be used by a single thread.

    Declaration
    public override SortedDocValues GetSortedDocValues(string field)
    Parameters
    Type Name Description
    string field
    Returns
    Type Description
    SortedDocValues
    Overrides
    FilterAtomicReader.GetSortedDocValues(string)

    GetSortedSetDocValues(string)

    Returns Lucene.Net.Index.SortedSetDocValues for this field, or null if no Lucene.Net.Index.SortedSetDocValues were indexed for this field. The returned instance should only be used by a single thread.

    Declaration
    public override SortedSetDocValues GetSortedSetDocValues(string field)
    Parameters
    Type Name Description
    string field
    Returns
    Type Description
    SortedSetDocValues
    Overrides
    FilterAtomicReader.GetSortedSetDocValues(string)

    GetTermVectors(int)

    Retrieve term vectors for this document, or null if term vectors were not indexed. The returned Lucene.Net.Index.Fields instance acts like a single-document inverted index (the docID will be 0).

    Declaration
    public override Fields GetTermVectors(int docID)
    Parameters
    Type Name Description
    int docID
    Returns
    Type Description
    Fields
    Overrides
    FilterAtomicReader.GetTermVectors(int)

    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.