Module org.elasticsearch.server

Package org.elasticsearch.script.field

Class BaseKeywordDocValuesField

java.lang.Object

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

org.elasticsearch.script.field.BaseKeywordDocValuesField

All Implemented Interfaces:

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

Direct Known Subclasses:

FlattenedDocValuesField, KeywordDocValuesField, MatchOnlyTextDocValuesField, TextDocValuesField

public abstract class BaseKeywordDocValuesField
extends AbstractScriptFieldFactory<String>
implements Field<String>, DocValuesScriptFieldFactory, ScriptDocValues.Supplier<String>

Field Summary

Fields

Modifier and Type	Field	Description
protected int	count
protected final SortedBinaryDocValues	input
protected final String	name
protected ScriptDocValues.Strings	strings
protected org.apache.lucene.util.BytesRefBuilder[]	values

Constructor Summary

Constructors

Constructor	Description
BaseKeywordDocValuesField(SortedBinaryDocValues input, String name)

Method Summary

Modifier and Type	Method	Description
protected static String	bytesToString(org.apache.lucene.util.BytesRef bytesRef)
String	get(int index, String defaultValue)
String	get(String defaultValue)
String	getInternal(int index)
String	getName()	Returns the name of this field.
boolean	isEmpty()	Returns true if this field has no values, otherwise false.
Iterator<String>	iterator()
void	setNextDocId(int docId)	Set the current document ID.
int	size()	Returns the number of values this field has.
ScriptDocValues<String>	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 SortedBinaryDocValues input

name

protected final String name

values

protected org.apache.lucene.util.BytesRefBuilder[] values

count

protected int count

strings

protected ScriptDocValues.Strings strings

Constructor Details

BaseKeywordDocValuesField

public BaseKeywordDocValuesField(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<String>

Throws:

IOException

toScriptDocValues

public ScriptDocValues<String> 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 String getInternal(int index)

Specified by:

getInternal in interface ScriptDocValues.Supplier<String>

bytesToString

protected static String bytesToString(org.apache.lucene.util.BytesRef bytesRef)

getName

public String getName()

Description copied from interface: Field

Returns the name of this field.

Specified by:

getName in interface Field<String>

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

size

public int size()

Description copied from interface: Field

Returns the number of values this field has.

Specified by:

size in interface Field<String>

Specified by:

size in interface ScriptDocValues.Supplier<String>

get

public String get(String defaultValue)

get

public String get(int index,
 String defaultValue)

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>