Module org.elasticsearch.server
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
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.MappedFieldType
MappedFieldType.CollapseType, MappedFieldType.FielddataOperation, MappedFieldType.Relation
-
Field Summary
Modifier and TypeFieldDescriptionprotected final DateMathParser
protected final DateFormatter
protected final String
protected final DateFieldMapper.Resolution
protected final FieldValues<Long>
-
Constructor Summary
ConstructorDescriptionDateFieldType
(String name) DateFieldType
(String name, boolean isIndexed) DateFieldType
(String name, boolean isIndexed, boolean pointsMetadataAvailable, boolean isStored, boolean hasDocValues, DateFormatter dateTimeFormatter, DateFieldMapper.Resolution resolution, String nullValue, FieldValues<Long> scriptValues, Map<String, String> meta) DateFieldType
(String name, boolean isIndexed, 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 TypeMethodDescriptionprotected 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) org.apache.lucene.search.Query
distanceFeatureQuery
(Object origin, String pivot, SearchExecutionContext context) docValueFormat
(String format, ZoneId timeZone) Pick aDocValueFormat
that can be used to display and parse values of fields of this type.fielddataBuilder
(FieldDataContext fieldDataContext) Return a fielddata builder for this fieldstatic org.apache.lucene.search.Query
handleNow
(SearchExecutionContext context, Function<LongSupplier, org.apache.lucene.search.Query> builder) Handlenow
in queries.isFieldWithinQuery
(long minValue, long maxValue, Object from, Object to, boolean includeLower, boolean includeUpper, ZoneId timeZone, DateMathParser dateParser, QueryRewriteContext context) 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 givenIndexReader
are within the range, outside the range or cross the range.boolean
Returns true if the field is searchable.boolean
mayExistInIndex
(SearchExecutionContext context) long
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) 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.org.apache.lucene.search.Query
termQuery
(Object value, SearchExecutionContext context) Generates a query that will only match documents that contain the given value.typeName()
Returns the name of this type, as would be specified in mapping propertiesvalueFetcher
(SearchExecutionContext context, String format) Create a helper class to fetch field values during theFetchFieldsPhase
.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
checkNoFormat, checkNoTimeZone, collapseType, eagerGlobalOrdinals, existsQuery, extractTerm, failIfNoDocValues, failIfNotIndexed, failIfNotIndexedNorDocValuesFallback, familyTypeName, fuzzyIntervals, fuzzyQuery, getMetricType, getTerms, getTextSearchInfo, hasDocValues, isAggregatable, isDimension, isIndexed, isStored, meta, multiPhraseQuery, name, normalizedWildcardQuery, phrasePrefixQuery, phraseQuery, prefixIntervals, prefixQuery, prefixQuery, regexpQuery, spanPrefixQuery, termIntervals, termQueryCaseInsensitive, termsQuery, validateMatchedRoutingPath, wildcardIntervals, wildcardQuery, wildcardQuery
-
Field Details
-
dateTimeFormatter
-
dateMathParser
-
resolution
-
nullValue
-
scriptValues
-
-
Constructor Details
-
DateFieldType
public DateFieldType(String name, boolean isIndexed, boolean pointsMetadataAvailable, boolean isStored, boolean hasDocValues, DateFormatter dateTimeFormatter, DateFieldMapper.Resolution resolution, String nullValue, FieldValues<Long> scriptValues, Map<String, String> meta) -
DateFieldType
public DateFieldType(String name, boolean isIndexed, boolean isStored, boolean hasDocValues, DateFormatter dateTimeFormatter, DateFieldMapper.Resolution resolution, String nullValue, FieldValues<Long> scriptValues, Map<String, String> meta) -
DateFieldType
-
DateFieldType
-
DateFieldType
-
DateFieldType
-
DateFieldType
public DateFieldType(String name, DateFieldMapper.Resolution resolution, DateFormatter dateFormatter)
-
-
Method Details
-
typeName
Description copied from class:MappedFieldType
Returns the name of this type, as would be specified in mapping properties- Specified by:
typeName
in classMappedFieldType
-
dateTimeFormatter
-
resolution
-
dateMathParser
-
parse
-
mayExistInIndex
- Overrides:
mayExistInIndex
in classMappedFieldType
- Returns:
- if the field may have values in the underlying index
Note that this should only return
false
if it is not possible for it to match on a term query. - See Also:
-
valueFetcher
Description copied from class:MappedFieldType
Create a helper class to fetch field values during theFetchFieldsPhase
. New field types must implement this method in order to support the search 'fields' option. Except for metadata fields, field types should not throwUnsupportedOperationException
since this could cause a search retrieving multiple fields (like "fields": ["*"]) to fail.- Specified by:
valueFetcher
in classMappedFieldType
-
isSearchable
public boolean isSearchable()Description copied from class:MappedFieldType
Returns true if the field is searchable.- Overrides:
isSearchable
in classMappedFieldType
-
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 aTermQuery
over the value bytes- Specified by:
termQuery
in classMappedFieldType
-
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 classMappedFieldType
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) Handlenow
in queries.- Parameters:
context
- context from which to read the current timebuilder
- build the query- Returns:
- the result of the builder, wrapped in
DateRangeIncludingNowQuery
ifnow
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 classMappedFieldType
-
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 givenIndexReader
are within the range, outside the range or cross the range. The default implementation returnsMappedFieldType.Relation.INTERSECTS
, which is always fine to return when there is no way to check whether values are actually within bounds.- Overrides:
isFieldWithinQuery
in classMappedFieldType
- 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) -
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 classMappedFieldType
- Returns:
- null if the optimization cannot be applied, otherwise a function to use for the optimization
-
fielddataBuilder
Description copied from class:MappedFieldType
Return a fielddata builder for this field- Overrides:
fielddataBuilder
in classMappedFieldType
- Parameters:
fieldDataContext
- the context for the fielddata
-
valueForDisplay
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 classMappedFieldType
-
docValueFormat
Description copied from class:MappedFieldType
Pick aDocValueFormat
that can be used to display and parse values of fields of this type.- Overrides:
docValueFormat
in classMappedFieldType
-