Package org.elasticsearch.search
Class DocValueFormat.BinaryDocValueFormat
java.lang.Object
org.elasticsearch.search.DocValueFormat.BinaryDocValueFormat
- All Implemented Interfaces:
NamedWriteable
,Writeable
,DocValueFormat
- Enclosing interface:
- DocValueFormat
Singleton, stateless formatter, for representing bytes as base64 strings
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.search.DocValueFormat
DocValueFormat.BinaryDocValueFormat, DocValueFormat.BooleanDocValueFormat, DocValueFormat.DateTime, DocValueFormat.Decimal, DocValueFormat.GeoHashDocValueFormat, DocValueFormat.GeoTileDocValueFormat, DocValueFormat.IpDocValueFormat, DocValueFormat.RawDocValueFormat, DocValueFormat.UnsignedLongShiftedDocValueFormat
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields inherited from interface org.elasticsearch.search.DocValueFormat
BIGINTEGER_2_64_MINUS_ONE, BINARY, BOOLEAN, GEOHASH, GEOTILE, IP, MASK_2_63, RAW, UNSIGNED_LONG_SHIFTED
-
Method Summary
Modifier and TypeMethodDescriptionformat
(org.apache.lucene.util.BytesRef value) Format a binary value.Returns the name of the writeable objectorg.apache.lucene.util.BytesRef
parseBytesRef
(String value) Parse a value that was formatted withDocValueFormat.format(BytesRef)
back to the original BytesRef.void
writeTo
(StreamOutput out) Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.search.DocValueFormat
format, format, formatSortValue, parseDouble, parseLong
-
Field Details
-
INSTANCE
-
-
Method Details
-
getWriteableName
Description copied from interface:NamedWriteable
Returns the name of the writeable object- Specified by:
getWriteableName
in interfaceNamedWriteable
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
format
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 thekeyword
andip
fields.- Specified by:
format
in interfaceDocValueFormat
-
parseBytesRef
Description copied from interface:DocValueFormat
Parse a value that was formatted withDocValueFormat.format(BytesRef)
back to the original BytesRef.- Specified by:
parseBytesRef
in interfaceDocValueFormat
-