org.elasticsearch.index.mapper.ip

Class IpFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.core.NumberFieldMapper

org.elasticsearch.index.mapper.ip.IpFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, ToXContent, AllFieldMapper.IncludeInAll

public class IpFieldMapper
extends NumberFieldMapper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IpFieldMapper.Builder
static class	IpFieldMapper.Defaults
static class	IpFieldMapper.IpFieldType
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, NumberFieldMapper.NumberFieldType

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 long	MAX_IP

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

coerce, ignoreMalformed, includeInAll, useSortedNumericDocValues

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IpFieldMapper(String simpleName, MappedFieldType fieldType, MappedFieldType defaultFieldType, Explicit<Boolean> ignoreMalformed, Explicit<Boolean> coerce, Settings indexSettings, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo)

Method Summary

Methods

Modifier and Type	Method and Description
static long[]	cidrMaskToMinMax(String cidr) Computes the min & max ip addresses (represented as long values - same way as stored in index) represented by the given CIDR mask expression.
protected String	contentType()
protected void	doXContentBody(XContentBuilder builder, boolean includeDefaults, ToXContent.Params params)
protected void	innerParseCreateField(ParseContext context, List<org.apache.lucene.document.Field> fields)
static long	ipToLong(String ip)
static String	longToIp(long longIp)

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

addDocValue, clone, doMerge, includeInAll, includeInAllIfNotSet, parseCreateField, parseDoubleValue, parseLongValue, unsetIncludeInAll

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

copyTo, customBoost, doXContentAnalyzers, doXContentDocValues, fieldType, hasCustomFieldDataSettings, indexOptionToString, indexTokenizeOptionToString, isGenerated, iterator, merge, name, parse, termVectorOptionsToString, toXContent, 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

Field Detail

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

MAX_IP

public static final long MAX_IP

See Also:

Constant Field Values

Constructor Detail

IpFieldMapper

protected IpFieldMapper(String simpleName,
             MappedFieldType fieldType,
             MappedFieldType defaultFieldType,
             Explicit<Boolean> ignoreMalformed,
             Explicit<Boolean> coerce,
             Settings indexSettings,
             FieldMapper.MultiFields multiFields,
             FieldMapper.CopyTo copyTo)

Method Detail

longToIp

public static String longToIp(long longIp)

ipToLong

public static long ipToLong(String ip)

cidrMaskToMinMax

public static long[] cidrMaskToMinMax(String cidr)

Computes the min & max ip addresses (represented as long values - same way as stored in index) represented by the given CIDR mask expression. The returned array has the length of 2, where the first entry represents the min address and the second the max. A -1 value for either the min or the max, represents an unbounded end. In other words:

min == -1 == "0.0.0.0"

and

max == -1 == "255.255.255.255"

innerParseCreateField

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

Specified by:

innerParseCreateField in class NumberFieldMapper

Throws:

IOException

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

doXContentBody

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

Overrides:

doXContentBody in class NumberFieldMapper

Throws:

IOException