Package org.opensearch.index.fielddata

Class ScriptDocValues<T>

java.lang.Object

java.util.AbstractCollection<T>

java.util.AbstractList<T>

org.opensearch.index.fielddata.ScriptDocValues<T>

All Implemented Interfaces:

Iterable<T>, Collection<T>, List<T>

Direct Known Subclasses:

IpFieldMapper.IpFieldType.IpScriptDocValues, ScriptDocValues.Booleans, ScriptDocValues.BytesRefs, ScriptDocValues.Dates, ScriptDocValues.Doubles, ScriptDocValues.GeoPoints, ScriptDocValues.Longs, ScriptDocValues.Strings, ScriptDocValues.UnsignedLongs

@PublicApi(since="1.0.0")
public abstract class ScriptDocValues<T>
extends AbstractList<T>

Script level doc values, the assumption is that any implementation will implement a getValue method.

Implementations should not internally re-use objects for the values that they return as a single ScriptDocValues instance can be reused to return values form multiple documents.

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ScriptDocValues.Booleans	Boolean values for scripted doc values
static final class	ScriptDocValues.BytesRefs	BytesRef values for scripted doc values
static final class	ScriptDocValues.Dates	Date values for scripted doc values
static final class	ScriptDocValues.Doubles	Double values for scripted doc values
static final class	ScriptDocValues.GeoPoints	Geo points for scripted doc values
static final class	ScriptDocValues.Longs	Long values for scripted doc values
static class	ScriptDocValues.Strings	String class for scripted doc values
static final class	ScriptDocValues.UnsignedLongs	Unsigned long values for scripted doc values (returned as BigInteger)

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
ScriptDocValues()

Method Summary

Modifier and Type	Method	Description
final void	add(int index, T element)
final boolean	remove(Object o)
final void	replaceAll(UnaryOperator<T> operator)
final T	set(int index, T element)
abstract void	setNextDocId(int docId)	Set the current doc ID.
final void	sort(Comparator<? super T> c)

Methods inherited from class java.util.AbstractList

add, addAll, clear, equals, get, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, removeAll, retainAll, size, spliterator, toArray, toArray

Constructor Details

ScriptDocValues

public ScriptDocValues()

Method Details

setNextDocId

public abstract void setNextDocId(int docId)
                           throws IOException

Set the current doc ID.

Throws:

IOException

add

public final void add(int index,
 T element)

Specified by:

add in interface List<T>

Overrides:

add in class AbstractList<T>

remove

public final boolean remove(Object o)

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface List<T>

Overrides:

remove in class AbstractCollection<T>

replaceAll

public final void replaceAll(UnaryOperator<T> operator)

set

public final T set(int index,
 T element)

Specified by:

set in interface List<T>

Overrides:

set in class AbstractList<T>

sort

public final void sort(Comparator<? super T> c)