Module org.elasticsearch.server

Package org.elasticsearch.search

Class DocValueFormat.IpDocValueFormat

java.lang.Object

org.elasticsearch.search.DocValueFormat.IpDocValueFormat

All Implemented Interfaces:

NamedWriteable, Writeable, DocValueFormat

Enclosing interface:

DocValueFormat

public static class DocValueFormat.IpDocValueFormat
extends Object
implements DocValueFormat

Stateless, singleton formatter for IP address data

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.search.DocValueFormat

DocValueFormat.BinaryDocValueFormat, DocValueFormat.BooleanDocValueFormat, DocValueFormat.DateTime, DocValueFormat.Decimal, DocValueFormat.DenseVectorDocValueFormat, DocValueFormat.GeoHashDocValueFormat, DocValueFormat.GeoTileDocValueFormat, DocValueFormat.IpDocValueFormat, DocValueFormat.RawDocValueFormat, DocValueFormat.TimeSeriesIdDocValueFormat, DocValueFormat.UnsignedLongShiftedDocValueFormat

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final DocValueFormat.IpDocValueFormat	INSTANCE

Fields inherited from interface org.elasticsearch.search.DocValueFormat

BIGINTEGER_2_64_MINUS_ONE, BINARY, BOOLEAN, DENSE_VECTOR, GEOHASH, GEOTILE, IP, MASK_2_63, RAW, TIME_SERIES_ID, UNSIGNED_LONG_SHIFTED

Method Summary

Modifier and Type	Method	Description
String	format(org.apache.lucene.util.BytesRef value)	Format a binary value.
String	getWriteableName()	Returns the name of the writeable object
org.apache.lucene.util.BytesRef	parseBytesRef(Object value)	Parse a value that was formatted with DocValueFormat.format(BytesRef) back to the original BytesRef.
String	toString()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.search.DocValueFormat

format, format, formatSortValue, parseDouble, parseLong

Field Details

INSTANCE

public static final DocValueFormat.IpDocValueFormat INSTANCE

Method Details

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

writeTo

public void writeTo(StreamOutput out)

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

format

public String format(org.apache.lucene.util.BytesRef value)

Description copied from interface: DocValueFormat

Format a binary value. This is used by terms aggregations to format keys for fields that use binary doc value representations such as the keyword and ip fields.

Specified by:

format in interface DocValueFormat

parseBytesRef

public org.apache.lucene.util.BytesRef parseBytesRef(Object value)

Description copied from interface: DocValueFormat

Parse a value that was formatted with DocValueFormat.format(BytesRef) back to the original BytesRef.

Specified by:

parseBytesRef in interface DocValueFormat

toString

public String toString()

Overrides:

toString in class Object