Class TermVectorsReader

Codec API for reading term vectors:

Note

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

Inheritance

object

TermVectorsReader

CompressingTermVectorsReader

Lucene40TermVectorsReader

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Codecs

Assembly: Lucene.Net.dll

Syntax

public abstract class TermVectorsReader : IDisposable

Constructors

TermVectorsReader()

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

Declaration

protected TermVectorsReader()

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

Create a clone that one caller at a time may use to read term vectors.

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

Get(int)

Returns term vectors for this document, or null if term vectors were not indexed. If offsets are available they are in an IOffsetAttribute available from the DocsAndPositionsEnum.

Declaration

public abstract Fields Get(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
Fields

RamBytesUsed()

Returns approximate RAM bytes used.

Declaration

public abstract long RamBytesUsed()

Returns

Type	Description
long

Implements

IDisposable