Class StoredFieldsReader

Codec API for reading stored fields.

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

Note

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

Inheritance

System.Object

StoredFieldsReader

CompressingStoredFieldsReader

Lucene40StoredFieldsReader

Implements

System.IDisposable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

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()

Declaration

public abstract object Clone()

Returns

Type	Description
System.Object

Dispose()

Disposes all resources used by this object.

Declaration

public void Dispose()

Dispose(Boolean)

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

Declaration

protected abstract void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

RamBytesUsed()

Returns approximate RAM bytes used.

Declaration

public abstract long RamBytesUsed()

Returns

Type	Description
System.Int64

VisitDocument(Int32, StoredFieldVisitor)

Visit the stored fields for document n.

Declaration

public abstract void VisitDocument(int n, StoredFieldVisitor visitor)

Parameters

Type	Name	Description
System.Int32	n
StoredFieldVisitor	visitor

Implements

System.IDisposable