org.elasticsearch.index.mapper.core

Class DateFieldMapper.DateFieldType

java.lang.Object

org.apache.lucene.document.FieldType

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.core.NumberFieldMapper.NumberFieldType

org.elasticsearch.index.mapper.core.DateFieldMapper.DateFieldType

All Implemented Interfaces:

org.apache.lucene.index.IndexableFieldType

Direct Known Subclasses:

TimestampFieldMapper.TimestampFieldType

Enclosing class:

DateFieldMapper

public static class DateFieldMapper.DateFieldType
extends NumberFieldMapper.NumberFieldType

Nested Class Summary

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

MappedFieldType.Relation

Nested classes/interfaces inherited from class org.apache.lucene.document.FieldType

org.apache.lucene.document.FieldType.LegacyNumericType

Field Summary

Fields

Modifier and Type	Field and Description
protected DateMathParser	dateMathParser
protected FormatDateTimeFormatter	dateTimeFormatter
protected java.util.concurrent.TimeUnit	timeUnit

Constructor Summary

Constructors

Modifier	Constructor and Description
	DateFieldType()
protected	DateFieldType(DateFieldMapper.DateFieldType ref)

Method Summary

Modifier and Type	Method and Description
void	checkCompatibility(MappedFieldType fieldType, java.util.List<java.lang.String> conflicts, boolean strict) Checks for any conflicts between this field type and other.
DateFieldMapper.DateFieldType	clone()
protected DateMathParser	dateMathParser()
FormatDateTimeFormatter	dateTimeFormatter()
boolean	equals(java.lang.Object o)
IndexFieldData.Builder	fielddataBuilder() Return a fielddata builder for this field.
org.apache.lucene.search.Query	fuzzyQuery(java.lang.Object value, Fuzziness fuzziness, int prefixLength, int maxExpansions, boolean transpositions)
int	hashCode()
org.apache.lucene.util.BytesRef	indexedValueForSearch(java.lang.Object value) Returns the indexed value used to construct search "values".
MappedFieldType.Relation	isFieldWithinQuery(org.apache.lucene.index.IndexReader reader, java.lang.Object from, java.lang.Object to, boolean includeLower, boolean includeUpper, org.joda.time.DateTimeZone timeZone, DateMathParser dateParser) Return whether all values of the given IndexReader are within the range, outside the range or cross the range.
protected long	parseStringValue(java.lang.String value)
long	parseToMilliseconds(java.lang.Object value, boolean inclusive, org.joda.time.DateTimeZone zone, DateMathParser forcedDateParser)
org.apache.lucene.search.Query	rangeQuery(java.lang.Object lowerTerm, java.lang.Object upperTerm, boolean includeLower, boolean includeUpper)
org.apache.lucene.search.Query	rangeQuery(java.lang.Object lowerTerm, java.lang.Object upperTerm, boolean includeLower, boolean includeUpper, org.joda.time.DateTimeZone timeZone, DateMathParser forcedDateParser)
void	setDateTimeFormatter(FormatDateTimeFormatter dateTimeFormatter)
void	setTimeUnit(java.util.concurrent.TimeUnit timeUnit)
FieldStats	stats(org.apache.lucene.index.IndexReader reader)
java.util.concurrent.TimeUnit	timeUnit()
java.lang.String	typeName() Returns the name of this type, as would be specified in mapping properties
java.lang.Long	value(java.lang.Object value) Returns the actual value of the field.
java.lang.Object	valueForSearch(java.lang.Object value) Returns the value that will be used as a result for search.

Methods inherited from class org.elasticsearch.index.mapper.core.NumberFieldMapper.NumberFieldType

isNumeric, useTermQueryWithQueryString

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

boost, createTerm, eagerGlobalOrdinals, failIfNoDocValues, hasDocValues, indexAnalyzer, isSortable, name, nullValue, nullValueAsString, nullValueQuery, prefixQuery, queryStringTermQuery, regexpQuery, searchAnalyzer, searchQuoteAnalyzer, setBoost, setEagerGlobalOrdinals, setHasDocValues, setIndexAnalyzer, setName, setNullValue, setSearchAnalyzer, setSearchQuoteAnalyzer, setSimilarity, similarity, termQuery, termsQuery

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

checkIfFrozen, docValuesType, freeze, indexOptions, numericPrecisionStep, numericType, omitNorms, pointDimensionCount, pointNumBytes, setDimensions, setDocValuesType, setIndexOptions, setNumericPrecisionStep, setNumericType, 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 Detail

dateTimeFormatter

protected FormatDateTimeFormatter dateTimeFormatter

timeUnit

protected java.util.concurrent.TimeUnit timeUnit

dateMathParser

protected DateMathParser dateMathParser

Constructor Detail

DateFieldType

public DateFieldType()

DateFieldType

protected DateFieldType(DateFieldMapper.DateFieldType ref)

Method Detail

clone

public DateFieldMapper.DateFieldType clone()

Specified by:

clone in class NumberFieldMapper.NumberFieldType

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,
                               boolean strict)

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 NumberFieldMapper.NumberFieldType

dateTimeFormatter

public FormatDateTimeFormatter dateTimeFormatter()

setDateTimeFormatter

public void setDateTimeFormatter(FormatDateTimeFormatter dateTimeFormatter)

timeUnit

public java.util.concurrent.TimeUnit timeUnit()

setTimeUnit

public void setTimeUnit(java.util.concurrent.TimeUnit timeUnit)

dateMathParser

protected DateMathParser dateMathParser()

parseStringValue

protected long parseStringValue(java.lang.String value)

value

public java.lang.Long value(java.lang.Object value)

Description copied from class: MappedFieldType

Returns the actual value of the field.

Specified by:

value in class NumberFieldMapper.NumberFieldType

indexedValueForSearch

public org.apache.lucene.util.BytesRef indexedValueForSearch(java.lang.Object value)

Description copied from class: MappedFieldType

Returns the indexed value used to construct search "values".

Overrides:

indexedValueForSearch in class MappedFieldType

valueForSearch

public java.lang.Object valueForSearch(java.lang.Object value)

Description copied from class: MappedFieldType

Returns the value that will be used as a result for search. Can be only of specific types...

Overrides:

valueForSearch in class NumberFieldMapper.NumberFieldType

rangeQuery

public org.apache.lucene.search.Query rangeQuery(java.lang.Object lowerTerm,
                                                 java.lang.Object upperTerm,
                                                 boolean includeLower,
                                                 boolean includeUpper)

Overrides:

rangeQuery in class MappedFieldType

fuzzyQuery

public org.apache.lucene.search.Query fuzzyQuery(java.lang.Object value,
                                                 Fuzziness fuzziness,
                                                 int prefixLength,
                                                 int maxExpansions,
                                                 boolean transpositions)

Specified by:

fuzzyQuery in class NumberFieldMapper.NumberFieldType

stats

public FieldStats stats(org.apache.lucene.index.IndexReader reader)
                 throws java.io.IOException

Overrides:

stats in class MappedFieldType

Returns:

a FieldStats instance that maps to the type of this field or null if the provided index has no stats about the current field

Throws:

java.io.IOException

rangeQuery

public org.apache.lucene.search.Query rangeQuery(java.lang.Object lowerTerm,
                                                 java.lang.Object upperTerm,
                                                 boolean includeLower,
                                                 boolean includeUpper,
                                                 @Nullable
                                                 org.joda.time.DateTimeZone timeZone,
                                                 @Nullable
                                                 DateMathParser forcedDateParser)

isFieldWithinQuery

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

parseToMilliseconds

public long parseToMilliseconds(java.lang.Object value,
                                boolean inclusive,
                                @Nullable
                                org.joda.time.DateTimeZone zone,
                                @Nullable
                                DateMathParser forcedDateParser)

fielddataBuilder

public IndexFieldData.Builder fielddataBuilder()

Description copied from class: MappedFieldType

Return a fielddata builder for this field.

Overrides:

fielddataBuilder in class MappedFieldType