Class StoredFieldsReader

Codec API for reading stored fields.

You need to implement VisitDocument(int, StoredFieldVisitor) to read the stored fields for a document, implement Clone() (creating clones of any IndexInputs used, etc), and Dispose(bool) to cleanup any allocated resources.

Note

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

Inheritance
object
StoredFieldsReader
CompressingStoredFieldsReader
Lucene40StoredFieldsReader
Implements
Inherited Members
Namespace: Lucene.Net.Codecs
Assembly: Lucene.Net.dll
Syntax
public abstract class StoredFieldsReader : IDisposable

Constructors

StoredFieldsReader()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Declaration
protected StoredFieldsReader()

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 abstract void CheckIntegrity()

Clone()

Codec API for reading stored fields.

You need to implement VisitDocument(int, StoredFieldVisitor) to read the stored fields for a document, implement Clone() (creating clones of any IndexInputs used, etc), and Dispose(bool) to cleanup any allocated resources.

Note

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

Declaration
public abstract object Clone()
Returns
Type Description
object

Dispose()

Disposes all resources used by this object.

Declaration
public void Dispose()

Dispose(bool)

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

Declaration
protected abstract void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

RamBytesUsed()

Returns approximate RAM bytes used.

Declaration
public abstract long RamBytesUsed()
Returns
Type Description
long

VisitDocument(int, StoredFieldVisitor)

Visit the stored fields for document n.

Declaration
public abstract void VisitDocument(int n, StoredFieldVisitor visitor)
Parameters
Type Name Description
int n
StoredFieldVisitor visitor

Implements