Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class IpFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.IpFieldMapper

All Implemented Interfaces:

Iterable<Mapper>, ToXContent, ToXContentFragment

public class IpFieldMapper
extends FieldMapper

A FieldMapper for ip addresses.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IpFieldMapper.Builder
static final class	IpFieldMapper.IpFieldType

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

FieldMapper.BuilderParams, FieldMapper.Conflicts, FieldMapper.CopyTo, FieldMapper.DimensionBuilder, FieldMapper.MergeValidator<T>, FieldMapper.MultiFields, FieldMapper.Parameter<T>, FieldMapper.Serializer<T>, FieldMapper.SerializerCheck<T>, FieldMapper.SyntheticSourceMode, FieldMapper.SyntheticSourceSupport, FieldMapper.TypeParser

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

Mapper.SourceKeepMode

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
static final FieldMapper.TypeParser	PARSER

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

builderParams, COERCE_SETTING, deprecationLogger, IGNORE_MALFORMED_SETTING, mappedFieldType

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

SYNTHETIC_SOURCE_KEEP_INDEX_SETTING, SYNTHETIC_SOURCE_KEEP_PARAM

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
void	doValidate(MappingLookup lookup)
IpFieldMapper.IpFieldType	fieldType()
FieldMapper.Builder	getMergeBuilder()	Returns a FieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);
boolean	ignoreMalformed()	Will this field ignore malformed values for this field and accept the document (true) or will it reject documents with malformed values for this field (false).
protected void	indexScriptValues(SearchLookup searchLookup, org.apache.lucene.index.LeafReaderContext readerContext, int doc, DocumentParserContext documentParserContext)	Run the script associated with the field and index the values that it emits This method should only be called if FieldMapper.hasScript() has returned true
protected void	parseCreateField(DocumentParserContext context)	Parse the field value and populate the fields on DocumentParserContext.doc().
protected FieldMapper.SyntheticSourceSupport	syntheticSourceSupport()	Returns implementation of synthetic source support for the mapper.

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

checkIncomingMergeType, copyTo, createTypeParserWithLegacySupport, doXContentBody, executeScript, fullPath, getTotalFieldsCount, hasScript, indexAnalyzers, iterator, merge, multiFields, multiFieldsIterator, notFromDynamicTemplates, notInMultiFields, parse, parsesArrayValue, sourceKeepMode, sourcePathUsedBy, supportsParsingObject, syntheticFieldLoader, toXContent, typeName, validate

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

freezeAndDeduplicateFieldType, internFieldName, leafName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

PARSER

public static final FieldMapper.TypeParser PARSER

Method Details

ignoreMalformed

public boolean ignoreMalformed()

Description copied from class: FieldMapper

Will this field ignore malformed values for this field and accept the document (true) or will it reject documents with malformed values for this field (false). Some fields don't have a concept of "malformed" and will return false here.

Overrides:

ignoreMalformed in class FieldMapper

fieldType

public IpFieldMapper.IpFieldType fieldType()

Overrides:

fieldType in class FieldMapper

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

parseCreateField

protected void parseCreateField(DocumentParserContext context)
                         throws IOException

Description copied from class: FieldMapper

Parse the field value and populate the fields on DocumentParserContext.doc(). Implementations of this method should ensure that on failing to parse parser.currentToken() must be the current failing token

Specified by:

parseCreateField in class FieldMapper

Throws:

IOException

indexScriptValues

protected void indexScriptValues(SearchLookup searchLookup,
 org.apache.lucene.index.LeafReaderContext readerContext,
 int doc,
 DocumentParserContext documentParserContext)

Description copied from class: FieldMapper

Run the script associated with the field and index the values that it emits This method should only be called if FieldMapper.hasScript() has returned true

Overrides:

indexScriptValues in class FieldMapper

Parameters:

searchLookup - a SearchLookup to be passed the script

readerContext - a LeafReaderContext exposing values from an incoming document

doc - the id of the document to execute the script against

documentParserContext - the ParseContext over the incoming document

getMergeBuilder

public FieldMapper.Builder getMergeBuilder()

Description copied from class: FieldMapper

Returns a FieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);

Specified by:

getMergeBuilder in class FieldMapper

doValidate

public void doValidate(MappingLookup lookup)

Overrides:

doValidate in class FieldMapper

syntheticSourceSupport

protected FieldMapper.SyntheticSourceSupport syntheticSourceSupport()

Description copied from class: FieldMapper

Returns implementation of synthetic source support for the mapper.
By default (meaning FieldMapper.SyntheticSourceSupport.Fallback), an exact full copy of parsed field value is stored separately and used for synthetic source.

Field mappers must override this method if they provide a more efficient field-specific implementation of synthetic source.

Overrides:

syntheticSourceSupport in class FieldMapper

Returns:

FieldMapper.SyntheticSourceMode