org.elasticsearch.index.mapper.ip

Class IpFieldMapper

java.lang.Object

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

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

org.elasticsearch.index.mapper.ip.IpFieldMapper

All Implemented Interfaces:

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

public class IpFieldMapper
extends NumberFieldMapper<Long>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IpFieldMapper.Builder
static class	IpFieldMapper.Defaults
static class	IpFieldMapper.NumericIpAnalyzer
static class	IpFieldMapper.NumericIpTokenizer
static class	IpFieldMapper.TypeParser

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

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

IpFieldMapper(FieldMapper.Names names, int precisionStep, float boost, org.apache.lucene.document.FieldType fieldType, Boolean docValues, String nullValue, Explicit<Boolean> ignoreMalformed, Explicit<Boolean> coerce, PostingsFormatProvider postingsProvider, DocValuesFormatProvider docValuesProvider, SimilarityProvider similarity, FieldMapper.Loading normsLoading, Settings fieldDataSettings, Settings indexSettings, AbstractFieldMapper.MultiFields multiFields, AbstractFieldMapper.CopyTo copyTo)

Method Summary

Modifier and Type	Method and Description
protected String	contentType()
FieldDataType	defaultFieldDataType()
org.apache.lucene.document.FieldType	defaultFieldType()
protected void	doXContentBody(XContentBuilder builder, boolean includeDefaults, ToXContent.Params params)
org.apache.lucene.search.Query	fuzzyQuery(String value, Fuzziness fuzziness, int prefixLength, int maxExpansions, boolean transpositions)
org.apache.lucene.util.BytesRef	indexedValueForSearch(Object value) Returns the indexed value used to construct search "values".
protected void	innerParseCreateField(ParseContext context, List<org.apache.lucene.document.Field> fields)
static long	ipToLong(String ip)
static String	longToIp(long longIp)
protected int	maxPrecisionStep()
void	merge(Mapper mergeWith, MergeContext mergeContext)
org.apache.lucene.search.Filter	nullValueFilter() Null value filter, returns null if there is no null value associated with the field.
org.apache.lucene.search.Filter	rangeFilter(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, QueryParseContext context)
org.apache.lucene.search.Filter	rangeFilter(QueryParseContext parseContext, Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, QueryParseContext context) A range filter based on the field data cache.
org.apache.lucene.search.Query	rangeQuery(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, QueryParseContext context)
Long	value(Object value) Returns the actual value of the field.
Object	valueForSearch(Object value) IPs should return as a string.

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, customBoost, defaultDocValuesFormat, defaultPostingFormat, docValuesFormatProvider, fieldDataType, fieldType, hasDocValues, indexAnalyzer, indexOptionToString, indexTokenizeOptionToString, isGenerated, isSortable, name, names, normsLoading, parse, postingsFormatProvider, prefixFilter, prefixQuery, queryStringTermQuery, regexpFilter, regexpQuery, searchAnalyzer, searchQuoteAnalyzer, similarity, stats, supportsNullValue, termsFilter, termVectorOptionsToString, toXContent, 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

name, parse, traverse, traverse

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

toXContent

Field Detail

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

IpFieldMapper

protected IpFieldMapper(FieldMapper.Names names,
                        int precisionStep,
                        float boost,
                        org.apache.lucene.document.FieldType fieldType,
                        Boolean docValues,
                        String nullValue,
                        Explicit<Boolean> ignoreMalformed,
                        Explicit<Boolean> coerce,
                        PostingsFormatProvider postingsProvider,
                        DocValuesFormatProvider docValuesProvider,
                        SimilarityProvider similarity,
                        FieldMapper.Loading normsLoading,
                        @Nullable
                        Settings fieldDataSettings,
                        Settings indexSettings,
                        AbstractFieldMapper.MultiFields multiFields,
                        AbstractFieldMapper.CopyTo copyTo)

Method Detail

longToIp

public static String longToIp(long longIp)

ipToLong

public static long ipToLong(String ip)
                     throws ElasticsearchIllegalArgumentException

Throws:

ElasticsearchIllegalArgumentException

defaultFieldType

public org.apache.lucene.document.FieldType defaultFieldType()

Specified by:

defaultFieldType in class AbstractFieldMapper<Long>

defaultFieldDataType

public FieldDataType defaultFieldDataType()

Specified by:

defaultFieldDataType in class AbstractFieldMapper<Long>

maxPrecisionStep

protected int maxPrecisionStep()

Specified by:

maxPrecisionStep in class NumberFieldMapper<Long>

value

public Long value(Object value)

Description copied from interface: FieldMapper

Returns the actual value of the field.

valueForSearch

public Object valueForSearch(Object value)

IPs should return as a string.

Specified by:

valueForSearch in interface FieldMapper<Long>

Overrides:

valueForSearch in class NumberFieldMapper<Long>

indexedValueForSearch

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

Description copied from interface: FieldMapper

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

Specified by:

indexedValueForSearch in interface FieldMapper<Long>

Overrides:

indexedValueForSearch in class AbstractFieldMapper<Long>

fuzzyQuery

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

Specified by:

fuzzyQuery in interface FieldMapper<Long>

Specified by:

fuzzyQuery in class NumberFieldMapper<Long>

rangeQuery

public org.apache.lucene.search.Query rangeQuery(Object lowerTerm,
                                                 Object upperTerm,
                                                 boolean includeLower,
                                                 boolean includeUpper,
                                                 @Nullable
                                                 QueryParseContext context)

Specified by:

rangeQuery in interface FieldMapper<Long>

Specified by:

rangeQuery in class NumberFieldMapper<Long>

rangeFilter

public org.apache.lucene.search.Filter rangeFilter(Object lowerTerm,
                                                   Object upperTerm,
                                                   boolean includeLower,
                                                   boolean includeUpper,
                                                   @Nullable
                                                   QueryParseContext context)

Specified by:

rangeFilter in interface FieldMapper<Long>

Specified by:

rangeFilter in class NumberFieldMapper<Long>

rangeFilter

public org.apache.lucene.search.Filter rangeFilter(QueryParseContext parseContext,
                                                   Object lowerTerm,
                                                   Object upperTerm,
                                                   boolean includeLower,
                                                   boolean includeUpper,
                                                   @Nullable
                                                   QueryParseContext context)

Description copied from class: NumberFieldMapper

A range filter based on the field data cache.

Specified by:

rangeFilter in class NumberFieldMapper<Long>

nullValueFilter

public org.apache.lucene.search.Filter nullValueFilter()

Description copied from interface: FieldMapper

Null value filter, returns null if there is no null value associated with the field.

Specified by:

nullValueFilter in interface FieldMapper<Long>

Overrides:

nullValueFilter in class AbstractFieldMapper<Long>

innerParseCreateField

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

Specified by:

innerParseCreateField in class NumberFieldMapper<Long>

Throws:

IOException

contentType

protected String contentType()

Specified by:

contentType in class AbstractFieldMapper<Long>

merge

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

Specified by:

merge in interface Mapper

Overrides:

merge in class NumberFieldMapper<Long>

Throws:

MergeMappingException

doXContentBody

protected void doXContentBody(XContentBuilder builder,
                              boolean includeDefaults,
                              ToXContent.Params params)
                       throws IOException

Overrides:

doXContentBody in class NumberFieldMapper<Long>

Throws:

IOException