Package org.elasticsearch.script.field

Class ByteDocValuesField

java.lang.Object

org.elasticsearch.script.field.AbstractScriptFieldFactory<Byte>

org.elasticsearch.script.field.ByteDocValuesField

All Implemented Interfaces:

Iterable<Byte>, ScriptDocValues.Supplier<Long>, DocValuesScriptFieldFactory, Field<Byte>, ScriptFieldFactory

public class ByteDocValuesField
extends AbstractScriptFieldFactory<Byte>
implements Field<Byte>, DocValuesScriptFieldFactory, ScriptDocValues.Supplier<Long>

Field Summary

Fields

Modifier and Type	Field	Description
protected int	count
protected final org.apache.lucene.index.SortedNumericDocValues	input
protected final String	name
protected byte[]	values

Constructor Summary

Constructors

Constructor	Description
ByteDocValuesField(org.apache.lucene.index.SortedNumericDocValues input, String name)

Method Summary

Modifier and Type	Method	Description
byte	get(int defaultValue)
byte	get(int index, int defaultValue)	Note: Constants in java and painless are ints, so letting the defaultValue be an int allows users to call this without casting.
Long	getInternal(int index)
String	getName()	Returns the name of this field.
boolean	isEmpty()	Returns true if this field has no values, otherwise false.
Iterator<Byte>	iterator()
protected void	resize(int newSize)
void	setNextDocId(int docId)	Set the current document ID.
int	size()	Returns the number of values this field has.
ScriptDocValues<Long>	toScriptDocValues()	Returns a ScriptDocValues of the appropriate type for this field.

Methods inherited from class org.elasticsearch.script.field.AbstractScriptFieldFactory

toScriptField

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

toScriptField

Field Details

input

protected final org.apache.lucene.index.SortedNumericDocValues input

name

protected final String name

values

protected byte[] values

count

protected int count

Constructor Details

ByteDocValuesField

public ByteDocValuesField(org.apache.lucene.index.SortedNumericDocValues input,
 String name)

Method Details

setNextDocId

public void setNextDocId(int docId)
                  throws IOException

Description copied from interface: DocValuesScriptFieldFactory

Set the current document ID.

Specified by:

setNextDocId in interface DocValuesScriptFieldFactory

Specified by:

setNextDocId in interface ScriptDocValues.Supplier<Long>

Throws:

IOException

resize

protected void resize(int newSize)

toScriptDocValues

public ScriptDocValues<Long> 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.

Specified by:

toScriptDocValues in interface DocValuesScriptFieldFactory

getInternal

public Long getInternal(int index)

Specified by:

getInternal in interface ScriptDocValues.Supplier<Long>

getName

public String getName()

Returns the name of this field.

Specified by:

getName in interface Field<Byte>

isEmpty

public boolean isEmpty()

Returns true if this field has no values, otherwise false.

Specified by:

isEmpty in interface Field<Byte>

size

public int size()

Returns the number of values this field has.

Specified by:

size in interface Field<Byte>

Specified by:

size in interface ScriptDocValues.Supplier<Long>

iterator

public Iterator<Byte> iterator()

Specified by:

iterator in interface Iterable<Byte>

get

public byte get(int defaultValue)

get

public byte get(int index,
 int defaultValue)

Note: Constants in java and painless are ints, so letting the defaultValue be an int allows users to call this without casting. A byte variable will be automatically widened to an int. If the user does pass a value outside the range, it will be cast down to a byte.