Module org.elasticsearch.server

Package org.elasticsearch.script.field

Class AbstractLongDocValuesField

java.lang.Object

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

org.elasticsearch.script.field.AbstractLongDocValuesField

All Implemented Interfaces:

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

Direct Known Subclasses:

LongDocValuesField, SeqNoDocValuesField, VersionDocValuesField

public abstract class AbstractLongDocValuesField
extends AbstractScriptFieldFactory<Long>
implements Field<Long>, 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 ScriptDocValues<?>	scriptDocValues
protected long[]	values

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected long	formatLong(long raw)	Override if long has special formatting.
long	get(int index, long defaultValue)	Returns the value at index as an long if it exists, otherwise defaultValue.
long	get(long defaultValue)	Returns the 0th index value as an long if it exists, otherwise defaultValue.
Long	getInternal(int index)
protected long	getLong(int index)
String	getName()	Returns the name of this field.
boolean	isEmpty()	Returns true if this field has no values, otherwise false.
PrimitiveIterator.OfLong	iterator()
protected ScriptDocValues<?>	newScriptDocValues()	Override if not using ScriptDocValues.Longs
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.

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

name

protected final String name

scriptDocValues

protected ScriptDocValues<?> scriptDocValues

input

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

values

protected long[] values

count

protected int count

Constructor Details

AbstractLongDocValuesField

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

Method Details

newScriptDocValues

protected ScriptDocValues<?> newScriptDocValues()

Override if not using ScriptDocValues.Longs

formatLong

protected long formatLong(long raw)

Override if long has special formatting.

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

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 Long getInternal(int index)

Specified by:

getInternal in interface ScriptDocValues.Supplier<Long>

getLong

protected long getLong(int index)

size

public int size()

Description copied from interface: Field

Returns the number of values this field has.

Specified by:

size in interface Field<Long>

Specified by:

size in interface ScriptDocValues.Supplier<Long>

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<Long>

getName

public String getName()

Description copied from interface: Field

Returns the name of this field.

Specified by:

getName in interface Field<Long>

iterator

public PrimitiveIterator.OfLong iterator()

Specified by:

iterator in interface Iterable<Long>

get

public long get(long defaultValue)

Returns the 0th index value as an long if it exists, otherwise defaultValue.

get

public long get(int index,
 long defaultValue)

Returns the value at index as an long if it exists, otherwise defaultValue.