Class PostingsReaderBase

The core terms dictionaries (BlockTermsReader, BlockTreeTermsReader) interact with a single instance of this class to manage creation of DocsEnum and DocsAndPositionsEnum instances. It provides an IndexInput (termsIn) where this class may read any previously stored data that it had written in its corresponding PostingsWriterBase at indexing time.

Note

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

Inheritance
System.Object
PostingsReaderBase
Lucene40PostingsReader
Lucene41PostingsReader
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 PostingsReaderBase : IDisposable

Constructors

| Improve this Doc View Source

PostingsReaderBase()

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

Declaration
protected PostingsReaderBase()

Methods

| Improve this Doc View Source

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()
| Improve this Doc View Source

DecodeTerm(Int64[], DataInput, FieldInfo, BlockTermState, Boolean)

Actually decode metadata for next term.

Declaration
public abstract void DecodeTerm(long[] longs, DataInput in, FieldInfo fieldInfo, BlockTermState state, bool absolute)
Parameters
Type Name Description
System.Int64[] longs
DataInput in
FieldInfo fieldInfo
BlockTermState state
System.Boolean absolute
See Also
EncodeTerm(System.Int64[], DataOutput, FieldInfo, BlockTermState, System.Boolean)
| Improve this Doc View Source

Dispose()

Disposes all resources used by this object.

Declaration
public void Dispose()
| Improve this Doc View Source

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
| Improve this Doc View Source

Docs(FieldInfo, BlockTermState, IBits, DocsEnum, DocsFlags)

Must fully consume state, since after this call that TermState may be reused.

Declaration
public abstract DocsEnum Docs(FieldInfo fieldInfo, BlockTermState state, IBits skipDocs, DocsEnum reuse, DocsFlags flags)
Parameters
Type Name Description
FieldInfo fieldInfo
BlockTermState state
IBits skipDocs
DocsEnum reuse
DocsFlags flags
Returns
Type Description
DocsEnum
| Improve this Doc View Source

DocsAndPositions(FieldInfo, BlockTermState, IBits, DocsAndPositionsEnum, DocsAndPositionsFlags)

Must fully consume state, since after this call that TermState may be reused.

Declaration
public abstract DocsAndPositionsEnum DocsAndPositions(FieldInfo fieldInfo, BlockTermState state, IBits skipDocs, DocsAndPositionsEnum reuse, DocsAndPositionsFlags flags)
Parameters
Type Name Description
FieldInfo fieldInfo
BlockTermState state
IBits skipDocs
DocsAndPositionsEnum reuse
DocsAndPositionsFlags flags
Returns
Type Description
DocsAndPositionsEnum
| Improve this Doc View Source

Init(IndexInput)

Performs any initialization, such as reading and verifying the header from the provided terms dictionary IndexInput.

Declaration
public abstract void Init(IndexInput termsIn)
Parameters
Type Name Description
IndexInput termsIn
| Improve this Doc View Source

NewTermState()

Return a newly created empty TermState.

Declaration
public abstract BlockTermState NewTermState()
Returns
Type Description
BlockTermState
| Improve this Doc View Source

RamBytesUsed()

Returns approximate RAM bytes used.

Declaration
public abstract long RamBytesUsed()
Returns
Type Description
System.Int64

Implements

System.IDisposable