Package org.elasticsearch.script.field

Class IpDocValuesField

java.lang.Object

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

org.elasticsearch.script.field.IpDocValuesField

All Implemented Interfaces:

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

public class IpDocValuesField
extends AbstractScriptFieldFactory<IPAddress>
implements Field<IPAddress>, DocValuesScriptFieldFactory, ScriptDocValues.Supplier<String>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	IpDocValuesField.SortedBinaryIpSupplier	Used if we do not have global ordinals, such as in the IP runtime field see: IpScriptFieldData
protected static class	IpDocValuesField.SortedSetIpSupplier	Used if we have access to global ordinals

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	name
protected final ScriptDocValues.Supplier<InetAddress>	raw
protected ScriptDocValues.Strings	strings

Constructor Summary

Constructors

Constructor	Description
IpDocValuesField(org.apache.lucene.index.SortedSetDocValues input, String name)
IpDocValuesField(SortedBinaryDocValues input, String name)

Method Summary

Modifier and Type	Method	Description
String	asString(int index, String defaultValue)
String	asString(String defaultValue)
List<String>	asStrings()
IPAddress	get(int index, IPAddress defaultValue)
IPAddress	get(IPAddress 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<IPAddress>	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

name

protected final String name

raw

protected final ScriptDocValues.Supplier<InetAddress> raw

strings

protected ScriptDocValues.Strings strings

Constructor Details

IpDocValuesField

public IpDocValuesField(org.apache.lucene.index.SortedSetDocValues input,
 String name)

IpDocValuesField

public IpDocValuesField(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

getInternal

public String getInternal(int index)

Specified by:

getInternal in interface ScriptDocValues.Supplier<String>

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

asString

public String asString(String defaultValue)

asString

public String asString(int index,
 String defaultValue)

asStrings

public List<String> asStrings()

getName

public String getName()

Description copied from interface: Field

Returns the name of this field.

Specified by:

getName in interface Field<IPAddress>

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

size

public int size()

Description copied from interface: Field

Returns the number of values this field has.

Specified by:

size in interface Field<IPAddress>

Specified by:

size in interface ScriptDocValues.Supplier<String>

get

public IPAddress get(IPAddress defaultValue)

get

public IPAddress get(int index,
 IPAddress defaultValue)

iterator

public Iterator<IPAddress> iterator()

Specified by:

iterator in interface Iterable<IPAddress>