org.elasticsearch.index.mapper.internal

Class TTLFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.core.AbstractFieldMapper<T>

org.elasticsearch.index.mapper.core.NumberFieldMapper<Long>

org.elasticsearch.index.mapper.core.LongFieldMapper

org.elasticsearch.index.mapper.internal.TTLFieldMapper

All Implemented Interfaces:

ToXContent, FieldMapper<Long>, AllFieldMapper.IncludeInAll, InternalMapper, Mapper, RootMapper

public class TTLFieldMapper
extends LongFieldMapper
implements InternalMapper, RootMapper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TTLFieldMapper.Builder
static class	TTLFieldMapper.Defaults
static class	TTLFieldMapper.TypeParser

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

LongFieldMapper.CustomLongNumericField

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

NumberFieldMapper.CustomLongNumericDocValuesField, NumberFieldMapper.CustomNumericDocValuesField, NumberFieldMapper.CustomNumericField

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

AbstractFieldMapper.CopyTo, AbstractFieldMapper.MultiFields

Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.Mapper

Mapper.BuilderContext

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.FieldMapper

FieldMapper.Loading, FieldMapper.Names

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_TYPE
static String	NAME

Fields inherited from class org.elasticsearch.index.mapper.core.NumberFieldMapper

coerce, ignoreMalformed, includeInAll, precisionStep, useSortedNumericDocValues

Fields inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper

boost, copyTo, customFieldDataSettings, docValues, docValuesFormat, fieldDataType, fieldType, indexAnalyzer, multiFields, names, normsLoading, postingsFormat, searchAnalyzer, similarity

Fields inherited from interface org.elasticsearch.index.mapper.Mapper

EMPTY_ARRAY

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Fields inherited from interface org.elasticsearch.index.mapper.FieldMapper

DOC_VALUES_FORMAT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TTLFieldMapper(org.apache.lucene.document.FieldType fieldType, EnabledAttributeMapper enabled, long defaultTTL, Explicit<Boolean> ignoreMalformed, Explicit<Boolean> coerce, PostingsFormatProvider postingsProvider, DocValuesFormatProvider docValuesProvider, Settings fieldDataSettings, Settings indexSettings)
	TTLFieldMapper(Settings indexSettings)

Method Summary

Modifier and Type	Method and Description
long	defaultTTL()
boolean	enabled()
boolean	hasDocValues()
boolean	includeInObject() Should the mapper be included in the root ObjectMapper.
protected void	innerParseCreateField(ParseContext context, List<org.apache.lucene.document.Field> fields)
void	merge(Mapper mergeWith, MergeContext mergeContext)
void	parse(ParseContext context)
void	postParse(ParseContext context) Called after Mapper.parse(ParseContext) on the RootObjectMapper.
void	preParse(ParseContext context) Called before Mapper.parse(ParseContext) on the RootObjectMapper.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Object	valueForSearch(long expirationTime)
Object	valueForSearch(Object value) Override the default behavior (to return the string, and return the actual Number instance).

Methods inherited from class org.elasticsearch.index.mapper.core.LongFieldMapper

contentType, customBoost, defaultFieldDataType, defaultFieldType, doXContentBody, fuzzyQuery, indexedValueForSearch, maxPrecisionStep, nullValueFilter, rangeFilter, rangeFilter, rangeQuery, stats, value

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

addDocValue, close, fieldDataTermsFilter, includeInAll, includeInAllIfNotSet, isNumeric, parseCreateField, parseDoubleValue, parseLongValue, popCachedStream, precisionStep, termFilter, termQuery, unsetIncludeInAll, useTermQueryWithQueryString

Methods inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper

boost, copyTo, defaultDocValuesFormat, defaultPostingFormat, docValuesFormatProvider, fieldDataType, fieldType, indexAnalyzer, indexOptionToString, indexTokenizeOptionToString, isGenerated, isSortable, name, names, normsLoading, postingsFormatProvider, prefixFilter, prefixQuery, queryStringTermQuery, regexpFilter, regexpQuery, searchAnalyzer, searchQuoteAnalyzer, similarity, supportsNullValue, termsFilter, termVectorOptionsToString, traverse, traverse

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.index.mapper.Mapper

close, name, traverse, traverse

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

TTLFieldMapper

public TTLFieldMapper(Settings indexSettings)

TTLFieldMapper

protected TTLFieldMapper(org.apache.lucene.document.FieldType fieldType,
                         EnabledAttributeMapper enabled,
                         long defaultTTL,
                         Explicit<Boolean> ignoreMalformed,
                         Explicit<Boolean> coerce,
                         PostingsFormatProvider postingsProvider,
                         DocValuesFormatProvider docValuesProvider,
                         @Nullable
                         Settings fieldDataSettings,
                         Settings indexSettings)

Method Detail

enabled

public boolean enabled()

defaultTTL

public long defaultTTL()

hasDocValues

public boolean hasDocValues()

Specified by:

hasDocValues in interface FieldMapper<Long>

Overrides:

hasDocValues in class AbstractFieldMapper<Long>

valueForSearch

public Object valueForSearch(Object value)

Description copied from class: NumberFieldMapper

Override the default behavior (to return the string, and return the actual Number instance).

Specified by:

valueForSearch in interface FieldMapper<Long>

Overrides:

valueForSearch in class NumberFieldMapper<Long>

valueForSearch

public Object valueForSearch(long expirationTime)

preParse

public void preParse(ParseContext context)
              throws IOException

Description copied from interface: RootMapper

Called before Mapper.parse(ParseContext) on the RootObjectMapper.

Specified by:

preParse in interface RootMapper

Throws:

IOException

postParse

public void postParse(ParseContext context)
               throws IOException

Description copied from interface: RootMapper

Called after Mapper.parse(ParseContext) on the RootObjectMapper.

Specified by:

postParse in interface RootMapper

Throws:

IOException

parse

public void parse(ParseContext context)
           throws IOException,
                  MapperParsingException

Specified by:

parse in interface Mapper

Overrides:

parse in class AbstractFieldMapper<Long>

Throws:

IOException

MapperParsingException

includeInObject

public boolean includeInObject()

Description copied from interface: RootMapper

Should the mapper be included in the root ObjectMapper. If this method returns true, then Mapper.parse(ParseContext) will be called if the context has a property that matches the name of this RootMapper. Otherwise Mapper.parse(ParseContext) will not be called.

Specified by:

includeInObject in interface RootMapper

innerParseCreateField

protected void innerParseCreateField(ParseContext context,
                                     List<org.apache.lucene.document.Field> fields)
                              throws IOException,
                                     AlreadyExpiredException

Overrides:

innerParseCreateField in class LongFieldMapper

Throws:

IOException

AlreadyExpiredException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Overrides:

toXContent in class AbstractFieldMapper<Long>

Throws:

IOException

merge

public void merge(Mapper mergeWith,
                  MergeContext mergeContext)
           throws MergeMappingException

Specified by:

merge in interface Mapper

Overrides:

merge in class LongFieldMapper

Throws:

MergeMappingException