Module org.elasticsearch.server

Package org.elasticsearch.script.field

Class BinaryDocValuesField

java.lang.Object

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

org.elasticsearch.script.field.BinaryDocValuesField

All Implemented Interfaces:

Iterable<ByteBuffer>, ScriptDocValues.Supplier<org.apache.lucene.util.BytesRef>, DocValuesScriptFieldFactory, Field<ByteBuffer>, ScriptFieldFactory

public class BinaryDocValuesField
extends AbstractScriptFieldFactory<ByteBuffer>
implements Field<ByteBuffer>, DocValuesScriptFieldFactory, ScriptDocValues.Supplier<org.apache.lucene.util.BytesRef>

Constructor Summary

Constructors

Constructor	Description
BinaryDocValuesField(SortedBinaryDocValues input, String name)

Method Summary

Modifier and Type	Method	Description
ByteBuffer	get(int index, ByteBuffer defaultValue)
ByteBuffer	get(ByteBuffer defaultValue)
org.apache.lucene.util.BytesRef	getInternal(int index)
String	getName()	Returns the name of this field.
boolean	isEmpty()	Returns true if this field has no values, otherwise false.
Iterator<ByteBuffer>	iterator()
void	setNextDocId(int docId)	Set the current document ID.
int	size()	Returns the number of values this field has.
ScriptDocValues<?>	toScriptDocValues()	Returns a ScriptDocValues of the appropriate type for this field.
protected ByteBuffer	toWrapped(int index)

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

Constructor Details

BinaryDocValuesField

public BinaryDocValuesField(SortedBinaryDocValues 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<org.apache.lucene.util.BytesRef>

Throws:

IOException

toScriptDocValues

public ScriptDocValues<?> toScriptDocValues()

Description copied from interface: DocValuesScriptFieldFactory

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 org.apache.lucene.util.BytesRef getInternal(int index)

Specified by:

getInternal in interface ScriptDocValues.Supplier<org.apache.lucene.util.BytesRef>

getName

public String getName()

Description copied from interface: Field

Returns the name of this field.

Specified by:

getName in interface Field<ByteBuffer>

isEmpty

public boolean isEmpty()

Description copied from interface: Field

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

Specified by:

isEmpty in interface Field<ByteBuffer>

size

public int size()

Description copied from interface: Field

Returns the number of values this field has.

Specified by:

size in interface Field<ByteBuffer>

Specified by:

size in interface ScriptDocValues.Supplier<org.apache.lucene.util.BytesRef>

toWrapped

protected ByteBuffer toWrapped(int index)

get

public ByteBuffer get(ByteBuffer defaultValue)

get

public ByteBuffer get(int index,
 ByteBuffer defaultValue)

iterator

public Iterator<ByteBuffer> iterator()

Specified by:

iterator in interface Iterable<ByteBuffer>