Package org.elasticsearch.index.mapper

Class DateFieldMapper.DateFieldType

java.lang.Object

org.apache.lucene.document.FieldType

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.DateFieldMapper.DateFieldType

All Implemented Interfaces:

org.apache.lucene.index.IndexableFieldType

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.Relation

Field Summary

Fields

Modifier and Type	Field	Description
protected DateMathParser	dateMathParser
protected DateFormatter	dateTimeFormatter
protected DateFieldMapper.Resolution	resolution

Constructor Summary

Constructors

Constructor	Description
DateFieldType()

Method Summary

Modifier and Type	Method	Description
void	checkCompatibility(MappedFieldType fieldType, java.util.List<java.lang.String> conflicts)	Checks for any conflicts between this field type and other.
MappedFieldType	clone()
protected DateMathParser	dateMathParser()
DateFormatter	dateTimeFormatter()
DocValueFormat	docValueFormat(java.lang.String format, java.time.ZoneId timeZone)	Return a DocValueFormat that can be used to display and parse values as returned by the fielddata API.
boolean	equals(java.lang.Object o)
org.apache.lucene.search.Query	existsQuery(QueryShardContext context)
IndexFieldData.Builder	fielddataBuilder(java.lang.String fullyQualifiedIndexName)	Return a fielddata builder for this field
int	hashCode()
MappedFieldType.Relation	isFieldWithinQuery(org.apache.lucene.index.IndexReader reader, java.lang.Object from, java.lang.Object to, boolean includeLower, boolean includeUpper, java.time.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.
MappedFieldType.Relation	isFieldWithinRange(org.apache.lucene.index.IndexReader reader, java.time.Instant fromInclusive, java.time.Instant toInclusive)	Return whether all values of the given IndexReader are within the range, outside the range or cross the range.
long	parse(java.lang.String value)
long	parseToLong(java.lang.Object value, boolean roundUp, java.time.ZoneId zone, DateMathParser forcedDateParser, QueryRewriteContext context)
org.apache.lucene.search.Query	rangeQuery(java.lang.Object lowerTerm, java.lang.Object upperTerm, boolean includeLower, boolean includeUpper, ShapeRelation relation, java.time.ZoneId timeZone, DateMathParser forcedDateParser, QueryShardContext context)	Factory method for range queries.
DateFieldMapper.Resolution	resolution()
org.apache.lucene.search.Query	termQuery(java.lang.Object value, QueryShardContext context)	Generates a query that will only match documents that contain the given value.
java.lang.String	typeName()	Returns the name of this type, as would be specified in mapping properties
java.lang.Object	valueForDisplay(java.lang.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, eagerGlobalOrdinals, extractTerm, failIfNoDocValues, failIfNotIndexed, fuzzyQuery, hasDocValues, indexAnalyzer, intervals, isAggregatable, isSearchable, meta, multiPhraseQuery, name, nullValue, nullValueAsString, phrasePrefixQuery, phraseQuery, prefixQuery, regexpQuery, searchAnalyzer, searchQuoteAnalyzer, setBoost, setEagerGlobalOrdinals, setHasDocValues, setIndexAnalyzer, setMeta, setName, setNullValue, setSearchAnalyzer, setSearchQuoteAnalyzer, setSimilarity, similarity, spanPrefixQuery, termsQuery, wildcardQuery

Methods inherited from class org.apache.lucene.document.FieldType

checkIfFrozen, docValuesType, freeze, getAttributes, indexOptions, omitNorms, pointDataDimensionCount, pointIndexDimensionCount, pointNumBytes, putAttribute, setDimensions, setDimensions, setDocValuesType, setIndexOptions, setOmitNorms, setStored, setStoreTermVectorOffsets, setStoreTermVectorPayloads, setStoreTermVectorPositions, setStoreTermVectors, setTokenized, stored, storeTermVectorOffsets, storeTermVectorPayloads, storeTermVectorPositions, storeTermVectors, tokenized, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

dateTimeFormatter

protected DateFormatter dateTimeFormatter

dateMathParser

protected DateMathParser dateMathParser

resolution

protected DateFieldMapper.Resolution resolution

Constructor Details

DateFieldType

public DateFieldType()

Method Details

clone

public MappedFieldType clone()

Specified by:

clone in class MappedFieldType

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class MappedFieldType

hashCode

public int hashCode()

Overrides:

hashCode in class MappedFieldType

typeName

public java.lang.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

checkCompatibility

public void checkCompatibility(MappedFieldType fieldType, java.util.List<java.lang.String> conflicts)

Description copied from class: MappedFieldType

Checks for any conflicts between this field type and other. If strict is true, all properties must be equal. Otherwise, only properties which must never change in an index are checked.

Overrides:

checkCompatibility in class MappedFieldType

dateTimeFormatter

public DateFormatter dateTimeFormatter()

resolution

public DateFieldMapper.Resolution resolution()

dateMathParser

protected DateMathParser dateMathParser()

parse

public long parse(java.lang.String value)

existsQuery

public org.apache.lucene.search.Query existsQuery(QueryShardContext context)

Specified by:

existsQuery in class MappedFieldType

termQuery

public org.apache.lucene.search.Query termQuery(java.lang.Object value, @Nullable QueryShardContext 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(java.lang.Object lowerTerm, java.lang.Object upperTerm, boolean includeLower, boolean includeUpper, ShapeRelation relation, @Nullable java.time.ZoneId timeZone, @Nullable DateMathParser forcedDateParser, QueryShardContext 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

parseToLong

public long parseToLong(java.lang.Object value, boolean roundUp, @Nullable java.time.ZoneId zone, @Nullable DateMathParser forcedDateParser, QueryRewriteContext context)

isFieldWithinQuery

public MappedFieldType.Relation isFieldWithinQuery(org.apache.lucene.index.IndexReader reader, java.lang.Object from, java.lang.Object to, boolean includeLower, boolean includeUpper, java.time.ZoneId timeZone, DateMathParser dateParser, QueryRewriteContext context) throws java.io.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:

java.io.IOException

isFieldWithinRange

public MappedFieldType.Relation isFieldWithinRange(org.apache.lucene.index.IndexReader reader, java.time.Instant fromInclusive, java.time.Instant toInclusive) throws java.io.IOException

Return whether all values of the given IndexReader are within the range, outside the range or cross the range. Unlike isFieldWithinQuery(org.apache.lucene.index.IndexReader, java.lang.Object, java.lang.Object, boolean, boolean, java.time.ZoneId, org.elasticsearch.common.time.DateMathParser, org.elasticsearch.index.query.QueryRewriteContext) this accepts values that are out of the range of the resolution of this field.

Parameters:

fromInclusive - start date, inclusive

toInclusive - end date, inclusive

Throws:

java.io.IOException

fielddataBuilder

public IndexFieldData.Builder fielddataBuilder(java.lang.String fullyQualifiedIndexName)

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

valueForDisplay

public java.lang.Object valueForDisplay(java.lang.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 java.lang.String format, java.time.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