Package org.elasticsearch.index.mapper

Class DateFieldMapper.DateFieldType

java.lang.Object

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.DateFieldMapper.DateFieldType

Enclosing class:

DateFieldMapper

public static final class DateFieldMapper.DateFieldType
extends MappedFieldType

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.MappedFieldType

MappedFieldType.CollapseType, MappedFieldType.Relation

Field Summary

Fields

Modifier and Type	Field	Description
protected DateMathParser	dateMathParser
protected DateFormatter	dateTimeFormatter
protected String	nullValue
protected DateFieldMapper.Resolution	resolution
protected FieldValues<Long>	scriptValues

Constructor Summary

Constructors

Constructor	Description
DateFieldType(String name)
DateFieldType(String name, boolean isSearchable, boolean isStored, boolean hasDocValues, DateFormatter dateTimeFormatter, DateFieldMapper.Resolution resolution, String nullValue, FieldValues<Long> scriptValues, Map<String,String> meta)
DateFieldType(String name, DateFormatter dateFormatter)
DateFieldType(String name, DateFieldMapper.Resolution resolution)
DateFieldType(String name, DateFieldMapper.Resolution resolution, DateFormatter dateFormatter)

Method Summary

Modifier and Type	Method	Description
protected DateMathParser	dateMathParser()
static org.apache.lucene.search.Query	dateRangeQuery(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, ZoneId timeZone, DateMathParser parser, SearchExecutionContext context, DateFieldMapper.Resolution resolution, BiFunction<Long,Long,org.apache.lucene.search.Query> builder)
DateFormatter	dateTimeFormatter()
org.apache.lucene.search.Query	distanceFeatureQuery(Object origin, String pivot, SearchExecutionContext context)
DocValueFormat	docValueFormat(String format, ZoneId timeZone)	Return a DocValueFormat that can be used to display and parse values as returned by the fielddata API.
IndexFieldData.Builder	fielddataBuilder(String fullyQualifiedIndexName, Supplier<SearchLookup> searchLookup)	Return a fielddata builder for this field
static org.apache.lucene.search.Query	handleNow(SearchExecutionContext context, Function<LongSupplier,org.apache.lucene.search.Query> builder)	Handle now in queries.
MappedFieldType.Relation	isFieldWithinQuery(long minValue, long maxValue, Object from, Object to, boolean includeLower, boolean includeUpper, ZoneId timeZone, DateMathParser dateParser, QueryRewriteContext context)
MappedFieldType.Relation	isFieldWithinQuery(org.apache.lucene.index.IndexReader reader, Object from, Object to, boolean includeLower, boolean includeUpper, ZoneId timeZone, DateMathParser dateParser, QueryRewriteContext context)	Return whether all values of the given IndexReader are within the range, outside the range or cross the range.
long	parse(String value)
long	parseToLong(Object value, boolean roundUp, ZoneId zone, DateMathParser dateParser, LongSupplier now)
static long	parseToLong(Object value, boolean roundUp, ZoneId zone, DateMathParser dateParser, LongSupplier now, DateFieldMapper.Resolution resolution)
Function<byte[],Number>	pointReaderIfPossible()	If the field supports using the indexed data to speed up operations related to ordering of data, such as sorting or aggs, return a function for doing that.
org.apache.lucene.search.Query	rangeQuery(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, ShapeRelation relation, ZoneId timeZone, DateMathParser forcedDateParser, SearchExecutionContext context)	Factory method for range queries.
DateFieldMapper.Resolution	resolution()
org.apache.lucene.search.Query	termQuery(Object value, SearchExecutionContext context)	Generates a query that will only match documents that contain the given value.
String	typeName()	Returns the name of this type, as would be specified in mapping properties
ValueFetcher	valueFetcher(SearchExecutionContext context, String format)	Create a helper class to fetch field values during the FetchFieldsPhase.
Object	valueForDisplay(Object value)	Given a value that comes from the stored fields API, convert it to the expected type.

Methods inherited from class org.elasticsearch.index.mapper.MappedFieldType

boost, collapseType, eagerGlobalOrdinals, existsQuery, extractTerm, failIfNoDocValues, failIfNotIndexed, familyTypeName, fuzzyIntervals, fuzzyQuery, getTerms, getTextSearchInfo, hasDocValues, isAggregatable, isSearchable, isStored, meta, multiPhraseQuery, name, normalizedWildcardQuery, phrasePrefixQuery, phraseQuery, prefixIntervals, prefixQuery, prefixQuery, regexpQuery, setBoost, spanPrefixQuery, termIntervals, termQueryCaseInsensitive, termsQuery, wildcardIntervals, wildcardQuery, wildcardQuery

Methods inherited from class java.lang.Object

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

Field Details

dateTimeFormatter

protected final DateFormatter dateTimeFormatter

dateMathParser

protected final DateMathParser dateMathParser

resolution

protected final DateFieldMapper.Resolution resolution

nullValue

protected final String nullValue

scriptValues

protected final FieldValues<Long> scriptValues

Constructor Details

DateFieldType

public DateFieldType(String name,
 boolean isSearchable,
 boolean isStored,
 boolean hasDocValues,
 DateFormatter dateTimeFormatter,
 DateFieldMapper.Resolution resolution,
 String nullValue,
 FieldValues<Long> scriptValues,
 Map<String,String> meta)

DateFieldType

public DateFieldType(String name)

DateFieldType

public DateFieldType(String name,
 DateFormatter dateFormatter)

DateFieldType

public DateFieldType(String name,
 DateFieldMapper.Resolution resolution)

DateFieldType

public DateFieldType(String name,
 DateFieldMapper.Resolution resolution,
 DateFormatter dateFormatter)

Method Details

typeName

public String typeName()

Description copied from class: MappedFieldType

Returns the name of this type, as would be specified in mapping properties

Specified by:

typeName in class MappedFieldType

dateTimeFormatter

public DateFormatter dateTimeFormatter()

resolution

public DateFieldMapper.Resolution resolution()

dateMathParser

protected DateMathParser dateMathParser()

parse

public long parse(String value)

valueFetcher

public ValueFetcher valueFetcher(SearchExecutionContext context,
 String format)

Description copied from class: MappedFieldType

Create a helper class to fetch field values during the FetchFieldsPhase.

New field types must implement this method in order to support the search 'fields' option. Except for metadata fields, field types should not throw UnsupportedOperationException since this could cause a search retrieving multiple fields (like "fields": ["*"]) to fail.

Specified by:

valueFetcher in class MappedFieldType

termQuery

public org.apache.lucene.search.Query termQuery(Object value,
 @Nullable
 SearchExecutionContext context)

Description copied from class: MappedFieldType

Generates a query that will only match documents that contain the given value. The default implementation returns a TermQuery over the value bytes, boosted by MappedFieldType.boost().

Specified by:

termQuery in class MappedFieldType

rangeQuery

public org.apache.lucene.search.Query rangeQuery(Object lowerTerm,
 Object upperTerm,
 boolean includeLower,
 boolean includeUpper,
 ShapeRelation relation,
 @Nullable
 ZoneId timeZone,
 @Nullable
 DateMathParser forcedDateParser,
 SearchExecutionContext context)

Description copied from class: MappedFieldType

Factory method for range queries.

Overrides:

rangeQuery in class MappedFieldType

relation - the relation, nulls should be interpreted like INTERSECTS

dateRangeQuery

public static org.apache.lucene.search.Query dateRangeQuery(Object lowerTerm,
 Object upperTerm,
 boolean includeLower,
 boolean includeUpper,
 @Nullable
 ZoneId timeZone,
 DateMathParser parser,
 SearchExecutionContext context,
 DateFieldMapper.Resolution resolution,
 BiFunction<Long,Long,org.apache.lucene.search.Query> builder)

handleNow

public static org.apache.lucene.search.Query handleNow(SearchExecutionContext context,
 Function<LongSupplier,org.apache.lucene.search.Query> builder)

Handle now in queries.

Parameters:

context - context from which to read the current time

builder - build the query

Returns:

the result of the builder, wrapped in DateRangeIncludingNowQuery if now was used.

parseToLong

public long parseToLong(Object value,
 boolean roundUp,
 @Nullable
 ZoneId zone,
 DateMathParser dateParser,
 LongSupplier now)

parseToLong

public static long parseToLong(Object value,
 boolean roundUp,
 @Nullable
 ZoneId zone,
 DateMathParser dateParser,
 LongSupplier now,
 DateFieldMapper.Resolution resolution)

distanceFeatureQuery

public org.apache.lucene.search.Query distanceFeatureQuery(Object origin,
 String pivot,
 SearchExecutionContext context)

Overrides:

distanceFeatureQuery in class MappedFieldType

isFieldWithinQuery

public MappedFieldType.Relation isFieldWithinQuery(org.apache.lucene.index.IndexReader reader,
 Object from,
 Object to,
 boolean includeLower,
 boolean includeUpper,
 ZoneId timeZone,
 DateMathParser dateParser,
 QueryRewriteContext context)
                                            throws IOException

Description copied from class: MappedFieldType

Return whether all values of the given IndexReader are within the range, outside the range or cross the range. The default implementation returns MappedFieldType.Relation.INTERSECTS, which is always fine to return when there is no way to check whether values are actually within bounds.

Overrides:

isFieldWithinQuery in class MappedFieldType

Throws:

IOException

isFieldWithinQuery

public MappedFieldType.Relation isFieldWithinQuery(long minValue,
 long maxValue,
 Object from,
 Object to,
 boolean includeLower,
 boolean includeUpper,
 ZoneId timeZone,
 DateMathParser dateParser,
 QueryRewriteContext context)
                                            throws IOException

Throws:

IOException

pointReaderIfPossible

public Function<byte[],Number> pointReaderIfPossible()

Description copied from class: MappedFieldType

If the field supports using the indexed data to speed up operations related to ordering of data, such as sorting or aggs, return a function for doing that. If it is unsupported for this field type, there is no need to override this method.

Overrides:

pointReaderIfPossible in class MappedFieldType

Returns:

null if the optimization cannot be applied, otherwise a function to use for the optimization

fielddataBuilder

public IndexFieldData.Builder fielddataBuilder(String fullyQualifiedIndexName,
 Supplier<SearchLookup> searchLookup)

Description copied from class: MappedFieldType

Return a fielddata builder for this field

Overrides:

fielddataBuilder in class MappedFieldType

Parameters:

fullyQualifiedIndexName - the name of the index this field-data is build for

searchLookup - a SearchLookup supplier to allow for accessing other fields values in the context of runtime fields

valueForDisplay

public Object valueForDisplay(Object value)

Description copied from class: MappedFieldType

Given a value that comes from the stored fields API, convert it to the expected type. For instance a date field would store dates as longs and format it back to a string in this method.

Overrides:

valueForDisplay in class MappedFieldType

docValueFormat

public DocValueFormat docValueFormat(@Nullable
 String format,
 ZoneId timeZone)

Description copied from class: MappedFieldType

Return a DocValueFormat that can be used to display and parse values as returned by the fielddata API. The default implementation returns a DocValueFormat.RAW.

Overrides:

docValueFormat in class MappedFieldType