org.elasticsearch.index.mapper.internal

Class TTLFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.MetadataFieldMapper

org.elasticsearch.index.mapper.internal.TTLFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, ToXContent

public class TTLFieldMapper
extends MetadataFieldMapper

Nested Class Summary

Nested Classes

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

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

FieldMapper.CopyTo, FieldMapper.MultiFields

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

Mapper.BuilderContext

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

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

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

copyTo, defaultFieldType, fieldType, indexCreatedBefore2x, multiFields

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method and Description
protected String	contentType()
long	defaultTTL()
protected void	doMerge(Mapper mergeWith, boolean updateAllTypes) Merge changes coming from mergeWith in place.
boolean	enabled()
Mapper	parse(ParseContext context) Parse using the provided ParseContext and return a mapping update if dynamic mappings modified the mappings, or null if mappings were not modified.
protected void	parseCreateField(ParseContext context, List<org.apache.lucene.document.Field> fields) Parse the field value and populate fields.
void	postParse(ParseContext context) Called after FieldMapper.parse(ParseContext) on the RootObjectMapper.
void	preParse(ParseContext context) Called before FieldMapper.parse(ParseContext) on the RootObjectMapper.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Object	valueForSearch(long expirationTime)

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

merge

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

clone, copyTo, customBoost, doXContentAnalyzers, doXContentBody, doXContentDocValues, fieldType, hasCustomFieldDataSettings, indexOptionToString, indexTokenizeOptionToString, isGenerated, iterator, name, termVectorOptionsToString, updateFieldType

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

simpleName

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

Method Detail

enabled

public boolean enabled()

defaultTTL

public long defaultTTL()

valueForSearch

public Object valueForSearch(long expirationTime)

preParse

public void preParse(ParseContext context)
              throws IOException

Description copied from class: MetadataFieldMapper

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

Specified by:

preParse in class MetadataFieldMapper

Throws:

IOException

postParse

public void postParse(ParseContext context)
               throws IOException

Description copied from class: MetadataFieldMapper

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

Specified by:

postParse in class MetadataFieldMapper

Throws:

IOException

parse

public Mapper parse(ParseContext context)
             throws IOException,
                    MapperParsingException

Description copied from class: FieldMapper

Parse using the provided ParseContext and return a mapping update if dynamic mappings modified the mappings, or null if mappings were not modified.

Overrides:

parse in class FieldMapper

Throws:

IOException

MapperParsingException

parseCreateField

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

Description copied from class: FieldMapper

Parse the field value and populate fields.

Specified by:

parseCreateField in class FieldMapper

Throws:

IOException

AlreadyExpiredException

toXContent

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

Specified by:

toXContent in interface ToXContent

Overrides:

toXContent in class FieldMapper

Throws:

IOException

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

doMerge

protected void doMerge(Mapper mergeWith,
                       boolean updateAllTypes)

Description copied from class: FieldMapper

Merge changes coming from mergeWith in place.

Overrides:

doMerge in class FieldMapper

updateAllTypes - TODO