Package org.elasticsearch.search
Class DocValueFormat.DateTime
java.lang.Object
org.elasticsearch.search.DocValueFormat.DateTime
- All Implemented Interfaces:
NamedWriteable
,Writeable
,DocValueFormat
- Enclosing interface:
- DocValueFormat
public static final class DocValueFormat.DateTime extends java.lang.Object implements DocValueFormat
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.search.DocValueFormat
DocValueFormat.DateTime, DocValueFormat.Decimal
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 java.lang.String
NAME
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
-
Constructor Summary
Constructors Constructor Description DateTime(StreamInput in)
DateTime(DateFormatter formatter, java.time.ZoneId timeZone, DateFieldMapper.Resolution resolution)
-
Method Summary
Modifier and Type Method Description java.lang.String
format(double value)
Format a double value.java.lang.String
format(long value)
Format a long value.java.lang.Object
formatSortValue(java.lang.Object value)
Formats a value of a sort field in a search response.DateMathParser
getDateMathParser()
java.lang.String
getWriteableName()
Returns the name of the writeable objectdouble
parseDouble(java.lang.String value, boolean roundUp, java.util.function.LongSupplier now)
Parse a value that was formatted withDocValueFormat.format(double)
back to the original double value.long
parseLong(java.lang.String value, boolean roundUp, java.util.function.LongSupplier now)
Parse a value that was formatted withDocValueFormat.format(long)
back to the original long value.java.lang.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, parseBytesRef
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
-
Constructor Details
-
DateTime
public DateTime(DateFormatter formatter, java.time.ZoneId timeZone, DateFieldMapper.Resolution resolution) -
DateTime
- Throws:
java.io.IOException
-
-
Method Details
-
getWriteableName
public java.lang.String 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. -
getDateMathParser
-
format
public java.lang.String format(long value)Description copied from interface:DocValueFormat
Format a long value. This is used by terms and histogram aggregations to format keys for fields that use longs as a doc value representation such as thelong
anddate
fields.- Specified by:
format
in interfaceDocValueFormat
-
format
public java.lang.String format(double value)Description copied from interface:DocValueFormat
Format a double value. This is used by terms and stats aggregations to format keys for fields that use numbers as a doc value representation such as thelong
,double
ordate
fields.- Specified by:
format
in interfaceDocValueFormat
-
formatSortValue
public java.lang.Object formatSortValue(java.lang.Object value)Description copied from interface:DocValueFormat
Formats a value of a sort field in a search response. This is used bySearchSortValues
to avoid sending the internal representation of a value of a sort field in a search response. The default implementation formatsBytesRef
but leave other types as-is.- Specified by:
formatSortValue
in interfaceDocValueFormat
-
parseLong
public long parseLong(java.lang.String value, boolean roundUp, java.util.function.LongSupplier now)Description copied from interface:DocValueFormat
Parse a value that was formatted withDocValueFormat.format(long)
back to the original long value.- Specified by:
parseLong
in interfaceDocValueFormat
-
parseDouble
public double parseDouble(java.lang.String value, boolean roundUp, java.util.function.LongSupplier now)Description copied from interface:DocValueFormat
Parse a value that was formatted withDocValueFormat.format(double)
back to the original double value.- Specified by:
parseDouble
in interfaceDocValueFormat
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-