Package org.elasticsearch.index.mapper

Enum Class DateFieldMapper.Resolution

java.lang.Object

java.lang.Enum<DateFieldMapper.Resolution>

org.elasticsearch.index.mapper.DateFieldMapper.Resolution

All Implemented Interfaces:

Serializable, Comparable<DateFieldMapper.Resolution>, Constable

Enclosing class:

DateFieldMapper

public static enum DateFieldMapper.Resolution
extends Enum<DateFieldMapper.Resolution>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MILLISECONDS
NANOSECONDS

Method Summary

Modifier and Type	Method	Description
abstract Instant	clampToValidRange(Instant instant)	Return the instant that this range can represent that is closest to the provided instant.
abstract long	convert(Instant instant)	Convert an Instant into a long value in this resolution.
protected abstract org.apache.lucene.search.Query	distanceFeatureQuery(String field, float boost, long origin, org.elasticsearch.core.TimeValue pivot)
static DateFieldMapper.Resolution	ofOrdinal(int ord)
abstract long	parsePointAsMillis(byte[] value)	Decode the points representation of this field as milliseconds.
abstract long	roundDownToMillis(long value)	Round the given raw value down to a number of milliseconds since the epoch.
abstract long	roundUpToMillis(long value)	Round the given raw value up to a number of milliseconds since the epoch.
abstract Instant	toInstant(long value)	Convert a long value in this resolution into an instant.
String	type()
static DateFieldMapper.Resolution	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DateFieldMapper.Resolution[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MILLISECONDS

public static final DateFieldMapper.Resolution MILLISECONDS

NANOSECONDS

public static final DateFieldMapper.Resolution NANOSECONDS

Method Details

values

public static DateFieldMapper.Resolution[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DateFieldMapper.Resolution valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

type

public String type()

convert

public abstract long convert(Instant instant)

Convert an Instant into a long value in this resolution.

toInstant

public abstract Instant toInstant(long value)

Convert a long value in this resolution into an instant.

clampToValidRange

public abstract Instant clampToValidRange(Instant instant)

Return the instant that this range can represent that is closest to the provided instant.

parsePointAsMillis

public abstract long parsePointAsMillis(byte[] value)

Decode the points representation of this field as milliseconds.

roundDownToMillis

public abstract long roundDownToMillis(long value)

Round the given raw value down to a number of milliseconds since the epoch.

roundUpToMillis

public abstract long roundUpToMillis(long value)

Round the given raw value up to a number of milliseconds since the epoch.

ofOrdinal

public static DateFieldMapper.Resolution ofOrdinal(int ord)

distanceFeatureQuery

protected abstract org.apache.lucene.search.Query distanceFeatureQuery(String field,
 float boost,
 long origin,
 org.elasticsearch.core.TimeValue pivot)