org.elasticsearch.index.mapper.internal
Class TTLFieldMapper

java.lang.Object
  org.elasticsearch.index.mapper.core.AbstractFieldMapper<T>
      org.elasticsearch.index.mapper.core.NumberFieldMapper<java.lang.Long>
          org.elasticsearch.index.mapper.core.LongFieldMapper
              org.elasticsearch.index.mapper.internal.TTLFieldMapper

All Implemented Interfaces:

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

public class TTLFieldMapper
extends LongFieldMapper
implements InternalMapper, RootMapper

Nested Class Summary

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

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

AbstractFieldMapper.OpenBuilder<T extends AbstractFieldMapper.Builder,Y extends AbstractFieldMapper>

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.MapParams, ToXContent.Params

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

FieldMapper.Names

Field Summary

static java.lang.String	CONTENT_TYPE
static java.lang.String	NAME

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

dFuzzyFactor, fuzzyFactor, includeInAll, precisionStep

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

boost, index, indexAnalyzer, indexOptions, names, omitNorms, omitTermFreqAndPositions, searchAnalyzer, store, termVector

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

EMPTY_ARRAY

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

EMPTY_PARAMS

Constructor Summary

	TTLFieldMapper()
protected	TTLFieldMapper(org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index, boolean enabled, long defaultTTL)

Method Summary

long	defaultTTL()
boolean	enabled()
boolean	includeInObject() Should the mapper be included in the root ObjectMapper.
void	merge(Mapper mergeWith, MergeContext mergeContext)
void	parse(ParseContext context)
protected org.apache.lucene.document.Fieldable	parseCreateField(ParseContext context)
void	postParse(ParseContext context)
void	preParse(ParseContext context)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	validate(ParseContext context)
java.lang.Object	valueForSearch(org.apache.lucene.document.Fieldable field) Override the default behavior (to return the string, and return the actual Number instance).
java.lang.Object	valueForSearch(long expirationTime)

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

contentType, customBoost, doXContentBody, fieldDataType, fuzzyQuery, fuzzyQuery, indexedValue, maxPrecisionStep, rangeFilter, rangeFilter, rangeQuery, value, valueFromString

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

close, fieldFilter, fieldQuery, includeInAll, includeInAllIfNotSet, parseFuzzyFactor, popCachedStream, precisionStep, useFieldQueryWithQueryString, valueAsString

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

analyzed, boost, index, indexAnalyzer, indexed, name, names, omitNorms, omitTermFreqAndPositions, queryStringTermQuery, searchAnalyzer, store, stored, termVector, 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 java.lang.String NAME

See Also:

Constant Field Values

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

TTLFieldMapper

public TTLFieldMapper()

TTLFieldMapper

protected TTLFieldMapper(org.apache.lucene.document.Field.Store store,
                         org.apache.lucene.document.Field.Index index,
                         boolean enabled,
                         long defaultTTL)

Method Detail

enabled

public boolean enabled()

defaultTTL

public long defaultTTL()

valueForSearch

public java.lang.Object valueForSearch(org.apache.lucene.document.Fieldable field)

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

Overrides:

valueForSearch in class NumberFieldMapper<java.lang.Long>

valueForSearch

public java.lang.Object valueForSearch(long expirationTime)

validate

public void validate(ParseContext context)
              throws MapperParsingException

Specified by:

validate in interface RootMapper

Throws:

MapperParsingException

preParse

public void preParse(ParseContext context)
              throws java.io.IOException

Specified by:

preParse in interface RootMapper

Throws:

java.io.IOException

postParse

public void postParse(ParseContext context)
               throws java.io.IOException

Specified by:

postParse in interface RootMapper

Throws:

java.io.IOException

parse

public void parse(ParseContext context)
           throws java.io.IOException,
                  MapperParsingException

Specified by:

parse in interface Mapper

Overrides:

parse in class AbstractFieldMapper<java.lang.Long>

Throws:

java.io.IOException

MapperParsingException

includeInObject

public boolean includeInObject()

Description copied from interface: RootMapper

Should the mapper be included in the root ObjectMapper.

Specified by:

includeInObject in interface RootMapper

parseCreateField

protected org.apache.lucene.document.Fieldable parseCreateField(ParseContext context)
                                                         throws java.io.IOException,
                                                                AlreadyExpiredException

Overrides:

parseCreateField in class LongFieldMapper

Throws:

java.io.IOException

AlreadyExpiredException

toXContent

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

Specified by:

toXContent in interface ToXContent

Overrides:

toXContent in class AbstractFieldMapper<java.lang.Long>

Throws:

java.io.IOException

merge

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

Specified by:

merge in interface Mapper

Overrides:

merge in class LongFieldMapper

Throws:

MergeMappingException