Class DocValuesProducer

Abstract API that produces numeric, binary and sorted docvalues.

This is a Lucene.NET EXPERIMENTAL API, use at your own risk
Inheritance
System.Object
DocValuesProducer
Lucene45DocValuesProducer
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 DocValuesProducer : IDisposable

Constructors

| Improve this Doc View Source

DocValuesProducer()

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

Declaration
protected DocValuesProducer()

Methods

| Improve this Doc View Source

CheckIntegrity()

Checks consistency of this producer.

Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.

This is a Lucene.NET INTERNAL API, use at your own risk
Declaration
public abstract void CheckIntegrity()
| 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

GetBinary(FieldInfo)

Returns BinaryDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

Declaration
public abstract BinaryDocValues GetBinary(FieldInfo field)
Parameters
Type Name Description
FieldInfo field
Returns
Type Description
BinaryDocValues
| Improve this Doc View Source

GetDocsWithField(FieldInfo)

Returns a IBits at the size of reader.MaxDoc, with turned on bits for each docid that does have a value for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

Declaration
public abstract IBits GetDocsWithField(FieldInfo field)
Parameters
Type Name Description
FieldInfo field
Returns
Type Description
IBits
| Improve this Doc View Source

GetNumeric(FieldInfo)

Returns NumericDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

Declaration
public abstract NumericDocValues GetNumeric(FieldInfo field)
Parameters
Type Name Description
FieldInfo field
Returns
Type Description
NumericDocValues
| Improve this Doc View Source

GetSorted(FieldInfo)

Returns SortedDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

Declaration
public abstract SortedDocValues GetSorted(FieldInfo field)
Parameters
Type Name Description
FieldInfo field
Returns
Type Description
SortedDocValues
| Improve this Doc View Source

GetSortedSet(FieldInfo)

Returns SortedSetDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

Declaration
public abstract SortedSetDocValues GetSortedSet(FieldInfo field)
Parameters
Type Name Description
FieldInfo field
Returns
Type Description
SortedSetDocValues
| Improve this Doc View Source

RamBytesUsed()

Returns approximate RAM bytes used.

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

Implements

System.IDisposable