Class FilterAtomicReader

A FilterAtomicReader contains another AtomicReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality. The class FilterAtomicReader itself simply implements all abstract methods of IndexReader with versions that pass all requests to the contained index reader. Subclasses of FilterAtomicReader may further override some of these methods and may also provide additional methods and fields.

NOTE: If you override LiveDocs, you will likely need to override NumDocs as well and vice-versa.

NOTE: If this FilterAtomicReader does not change the content the contained reader, you could consider overriding CoreCacheKey so that IFieldCache and CachingWrapperFilter share the same entries for this atomic reader and the wrapped one. CombinedCoreAndDeletesKey could be overridden as well if the LiveDocs are not changed either.

Inheritance
System.Object
IndexReader
AtomicReader
FilterAtomicReader
Inherited Members
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public class FilterAtomicReader : AtomicReader

Constructors

| Improve this Doc View Source

FilterAtomicReader(AtomicReader)

Construct a FilterAtomicReader based on the specified base reader.

Note that base reader is closed if this FilterAtomicReader is closed.

Declaration
public FilterAtomicReader(AtomicReader input)
Parameters
Type Name Description
AtomicReader input

specified base reader.

Fields

| Improve this Doc View Source

m_input

The underlying AtomicReader.

Declaration
protected readonly AtomicReader m_input
Field Value
Type Description
AtomicReader

Properties

| Improve this Doc View Source

FieldInfos

Declaration
public override FieldInfos FieldInfos { get; }
Property Value
Type Description
FieldInfos
Overrides
| Improve this Doc View Source

Fields

Declaration
public override Fields Fields { get; }
Property Value
Type Description
Fields
Overrides
| Improve this Doc View Source

LiveDocs

Declaration
public override IBits LiveDocs { get; }
Property Value
Type Description
IBits
Overrides
| Improve this Doc View Source

MaxDoc

Declaration
public override int MaxDoc { get; }
Property Value
Type Description
System.Int32
Overrides
| Improve this Doc View Source

NumDocs

Declaration
public override int NumDocs { get; }
Property Value
Type Description
System.Int32
Overrides

Methods

| Improve this Doc View Source

CheckIntegrity()

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

DoClose()

Declaration
protected override void DoClose()
Overrides
| Improve this Doc View Source

Document(Int32, StoredFieldVisitor)

Declaration
public override void Document(int docID, StoredFieldVisitor visitor)
Parameters
Type Name Description
System.Int32 docID
StoredFieldVisitor visitor
Overrides
| Improve this Doc View Source

GetBinaryDocValues(String)

Declaration
public override BinaryDocValues GetBinaryDocValues(string field)
Parameters
Type Name Description
System.String field
Returns
Type Description
BinaryDocValues
Overrides
| Improve this Doc View Source

GetDocsWithField(String)

Declaration
public override IBits GetDocsWithField(string field)
Parameters
Type Name Description
System.String field
Returns
Type Description
IBits
Overrides
| Improve this Doc View Source

GetNormValues(String)

Declaration
public override NumericDocValues GetNormValues(string field)
Parameters
Type Name Description
System.String field
Returns
Type Description
NumericDocValues
Overrides
| Improve this Doc View Source

GetNumericDocValues(String)

Declaration
public override NumericDocValues GetNumericDocValues(string field)
Parameters
Type Name Description
System.String field
Returns
Type Description
NumericDocValues
Overrides
| Improve this Doc View Source

GetSortedDocValues(String)

Declaration
public override SortedDocValues GetSortedDocValues(string field)
Parameters
Type Name Description
System.String field
Returns
Type Description
SortedDocValues
Overrides
| Improve this Doc View Source

GetSortedSetDocValues(String)

Declaration
public override SortedSetDocValues GetSortedSetDocValues(string field)
Parameters
Type Name Description
System.String field
Returns
Type Description
SortedSetDocValues
Overrides
| Improve this Doc View Source

GetTermVectors(Int32)

Declaration
public override Fields GetTermVectors(int docID)
Parameters
Type Name Description
System.Int32 docID
Returns
Type Description
Fields
Overrides
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
| Improve this Doc View Source

Unwrap(AtomicReader)

Get the wrapped instance by reader as long as this reader is an intance of FilterAtomicReader.

Declaration
public static AtomicReader Unwrap(AtomicReader reader)
Parameters
Type Name Description
AtomicReader reader
Returns
Type Description
AtomicReader