Module org.elasticsearch.server

Package org.elasticsearch.script.field

Interface DocValuesScriptFieldFactory

All Superinterfaces:

ScriptFieldFactory

All Known Implementing Classes:

AbstractLongDocValuesField, BaseKeywordDocValuesField, BinaryDenseVectorDocValuesField, BinaryDocValuesField, BooleanDocValuesField, ByteBinaryDenseVectorDocValuesField, ByteDocValuesField, ByteKnnDenseVectorDocValuesField, DateMillisDocValuesField, DateNanosDocValuesField, DelegateDocValuesField, DenseVectorDocValuesField, DoubleDocValuesField, FlattenedDocValuesField, FloatDocValuesField, GeoPointDocValuesField, HalfFloatDocValuesField, IntegerDocValuesField, IpDocValuesField, KeywordDocValuesField, KnnDenseVectorDocValuesField, LongDocValuesField, MatchOnlyTextDocValuesField, PointDocValuesField, ScaledFloatDocValuesField, SeqNoDocValuesField, ShortDocValuesField, TextDocValuesField, VersionDocValuesField

public interface DocValuesScriptFieldFactory
extends ScriptFieldFactory

This interface is used to mark classes that generate both Field and ScriptDocValues for use in a script.

Method Summary

Modifier and Type	Method	Description
void	setNextDocId(int docId)	Set the current document ID.
ScriptDocValues<?>	toScriptDocValues()	Returns a ScriptDocValues of the appropriate type for this field.

Methods inherited from interface org.elasticsearch.script.field.ScriptFieldFactory

toScriptField

Method Details

setNextDocId

void setNextDocId(int docId)
           throws IOException

Set the current document ID.

Throws:

IOException

toScriptDocValues

ScriptDocValues<?> toScriptDocValues()

Returns a ScriptDocValues of the appropriate type for this field. This is used to support backwards compatibility for accessing field values through the doc variable.