Package org.elasticsearch.script

Class IpFieldScript

java.lang.Object

org.elasticsearch.script.AbstractFieldScript

org.elasticsearch.script.IpFieldScript

public abstract class IpFieldScript
extends AbstractFieldScript

Script producing IP addresses. Unlike the other AbstractFieldScripts which deal with their native java objects this converts its values to the same format that Lucene uses to store its fields, InetAddressPoint. There are a few compelling reasons to do this:

• Inet4Addresses and Inet6Address are not comparable with one another. That is correct in some contexts, but not for our queries. Our queries must consider the IPv4 address equal to the address that it maps to in IPv6 rfc4291).
• InetAddresses are not ordered, but we need to implement range queries with same same ordering as IpFieldMapper. That also uses InetAddressPoint so it saves us a lot of trouble to use the same representation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IpFieldScript.Emit
static interface	IpFieldScript.Factory
static interface	IpFieldScript.LeafFactory

Field Summary

Fields

Modifier and Type	Field	Description
static ScriptContext<IpFieldScript.Factory>	CONTEXT
static String[]	PARAMETERS
static IpFieldScript.Factory	PARSE_FROM_SOURCE

Fields inherited from class org.elasticsearch.script.AbstractFieldScript

fieldName, leafSearchLookup, MAX_VALUES

Constructor Summary

Constructors

Constructor	Description
IpFieldScript(String fieldName, Map<String,Object> params, SearchLookup searchLookup, org.apache.lucene.index.LeafReaderContext ctx)

Method Summary

Modifier and Type	Method	Description
int	count()	The number of results produced the last time runForDoc(int) was called.
void	emit(String v)
protected void	emitFromObject(Object v)
void	runForDoc(int docId)	Execute the script for the provided docId.
void	runForDoc(int docId, Consumer<InetAddress> consumer)
org.apache.lucene.util.BytesRef[]	values()	Values from the last time runForDoc(int) was called.

Methods inherited from class org.elasticsearch.script.AbstractFieldScript

checkMaxSize, emitFromSource, execute, extractFromSource, getDoc, getParams, setDocument

Methods inherited from class java.lang.Object

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

Field Details

CONTEXT

public static final ScriptContext<IpFieldScript.Factory> CONTEXT

PARSE_FROM_SOURCE

public static final IpFieldScript.Factory PARSE_FROM_SOURCE

PARAMETERS

public static final String[] PARAMETERS

Constructor Details

IpFieldScript

public IpFieldScript(String fieldName,
 Map<String,Object> params,
 SearchLookup searchLookup,
 org.apache.lucene.index.LeafReaderContext ctx)

Method Details

runForDoc

public final void runForDoc(int docId)

Execute the script for the provided docId.

runForDoc

public final void runForDoc(int docId,
 Consumer<InetAddress> consumer)

values

public final org.apache.lucene.util.BytesRef[] values()

Values from the last time runForDoc(int) was called. This array is mutable and will change with the next call of runForDoc(int). It is also oversized and will contain garbage at all indices at and above count().

All values are IPv6 addresses so they are 16 bytes. IPv4 addresses are encoded by rfc4291.

count

public final int count()

The number of results produced the last time runForDoc(int) was called.

emitFromObject

protected void emitFromObject(Object v)

Specified by:

emitFromObject in class AbstractFieldScript

emit

public final void emit(String v)