org.elasticsearch.index.mapper

Class LegacyDateFieldMapper.DateFieldType

java.lang.Object

org.apache.lucene.document.FieldType

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.LegacyNumberFieldMapper.NumberFieldType

org.elasticsearch.index.mapper.LegacyDateFieldMapper.DateFieldType

All Implemented Interfaces:

org.apache.lucene.index.IndexableFieldType

Direct Known Subclasses:

TimestampFieldMapper.TimestampFieldType

Enclosing class:

LegacyDateFieldMapper

public static class LegacyDateFieldMapper.DateFieldType
extends LegacyNumberFieldMapper.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(LegacyDateFieldMapper.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.
LegacyDateFieldMapper.DateFieldType	clone()
protected DateMathParser	dateMathParser()
FormatDateTimeFormatter	dateTimeFormatter()
DocValueFormat	docValueFormat(java.lang.String format, org.joda.time.DateTimeZone 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)
IndexFieldData.Builder	fielddataBuilder() Return a fielddata builder for this field
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, QueryRewriteContext context) 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, QueryRewriteContext context)
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, QueryShardContext context)
org.apache.lucene.search.Query	rangeQuery(java.lang.Object lowerTerm, java.lang.Object upperTerm, boolean includeLower, boolean includeUpper, QueryShardContext context)
void	setDateTimeFormatter(FormatDateTimeFormatter dateTimeFormatter)
void	setTimeUnit(java.util.concurrent.TimeUnit timeUnit)
FieldStats.Date	stats(org.apache.lucene.index.IndexReader reader)
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.
org.apache.lucene.search.Query	termsQuery(java.util.List<?> values, QueryShardContext context) Build a constant-scoring query that matches all values.
java.util.concurrent.TimeUnit	timeUnit()
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, isAggregatable, isSearchable, name, nullValue, nullValueAsString, nullValueQuery, prefixQuery, queryStringTermQuery, regexpQuery, searchAnalyzer, searchQuoteAnalyzer, setBoost, setEagerGlobalOrdinals, setHasDocValues, setIndexAnalyzer, setName, setNullValue, setSearchAnalyzer, setSearchQuoteAnalyzer, setSimilarity, similarity

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(LegacyDateFieldMapper.DateFieldType ref)

Method Detail

clone

public LegacyDateFieldMapper.DateFieldType clone()

Specified by:

clone in class LegacyNumberFieldMapper.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 LegacyNumberFieldMapper.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)

indexedValueForSearch

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

Returns the indexed value used to construct search "values". This method is used for the default implementations of most query factory methods such as termQuery(java.lang.Object, org.elasticsearch.index.query.QueryShardContext).

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

rangeQuery

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

Overrides:

rangeQuery in class MappedFieldType

stats

public FieldStats.Date 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,
                                                 QueryShardContext context)

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,
                                                   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

parseToMilliseconds

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

fielddataBuilder

public IndexFieldData.Builder fielddataBuilder()

Description copied from class: MappedFieldType

Return a fielddata builder for this field

Overrides:

fielddataBuilder in class MappedFieldType

docValueFormat

public DocValueFormat docValueFormat(@Nullable
                                     java.lang.String format,
                                     org.joda.time.DateTimeZone 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 LegacyNumberFieldMapper.NumberFieldType

termQuery

public org.apache.lucene.search.Query termQuery(java.lang.Object value,
                                                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

termsQuery

public org.apache.lucene.search.Query termsQuery(java.util.List<?> values,
                                                 QueryShardContext context)

Description copied from class: MappedFieldType

Build a constant-scoring query that matches all values. The default implementation uses a ConstantScoreQuery around a BooleanQuery whose BooleanClause.Occur.SHOULD clauses are generated with MappedFieldType.termQuery(java.lang.Object, org.elasticsearch.index.query.QueryShardContext).

Overrides:

termsQuery in class MappedFieldType