Class FieldCacheSource

Expert: A base class for ValueSource implementations that retrieve values for a single field from the FieldCache.

Fields used herein nust be indexed (doesn't matter if these fields are stored or not).

It is assumed that each such indexed field is untokenized, or at least has a single token in a document. For documents with multiple tokens of the same field, behavior is undefined (It is likely that current code would use the value of one of these tokens, but this is not guaranteed).

Document with no tokens in this field are assigned the Zero value.

WARNING: The status of the Search.Function package is experimental. The APIs introduced here might change in the future and will not be supported anymore in such a case.

NOTE: with the switch in 2.9 to segment-based searching, if GetValues(IndexReader) is invoked with a composite (multi-segment) reader, this can easily cause double RAM usage for the values in the FieldCache. It's best to switch your application to pass only atomic (single segment) readers to this API.

Inheritance
System.Object
ValueSource
FieldCacheSource
ByteFieldSource
FloatFieldSource
IntFieldSource
ShortFieldSource
Inherited Members
Namespace:
Assembly: Lucene.Net.NetCore.dll
Syntax
public abstract class FieldCacheSource : ValueSource

Constructors

Name Description
FieldCacheSource(String)

Create a cached field source for the input field.

Methods

Name Description
CachedFieldSourceEquals(FieldCacheSource)

Check if equals to another FieldCacheSource, already knowing that cache and field are equal.

CachedFieldSourceHashCode()

Return a hash code of a FieldCacheSource, without the hash-codes of the field and the cache (those are taken care of elsewhere).

Description()
Equals(Object)
GetCachedFieldValues(FieldCache, String, IndexReader)

Return cached DocValues for input field and reader.
GetHashCode()
GetValues(IndexReader)