Module org.elasticsearch.server

Package org.elasticsearch.index.mapper.vectors

Class SparseVectorFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.vectors.SparseVectorFieldMapper

All Implemented Interfaces:

Iterable<Mapper>, ToXContent, ToXContentFragment

public class SparseVectorFieldMapper
extends FieldMapper

A FieldMapper that exposes Lucene's FeatureField as a sparse vector of features.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SparseVectorFieldMapper.Builder
static final class	SparseVectorFieldMapper.SparseVectorFieldType

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

FieldMapper.Conflicts, FieldMapper.CopyTo, FieldMapper.MergeValidator<T>, FieldMapper.MultiFields, FieldMapper.Parameter<T>, FieldMapper.Serializer<T>, FieldMapper.SerializerCheck<T>, FieldMapper.TypeParser

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

COERCE_SETTING, copyTo, deprecationLogger, hasScript, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields, onScriptError

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
SparseVectorFieldMapper.SparseVectorFieldType	fieldType()
FieldMapper.Builder	getMergeBuilder()	Returns a FieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);
Map<String,NamedAnalyzer>	indexAnalyzers()
void	parse(DocumentParserContext context)	Parse the field value using the provided DocumentParserContext.
protected void	parseCreateField(DocumentParserContext context)	Parse the field value and populate the fields on DocumentParserContext.doc().
protected boolean	supportsParsingObject()	Whether this mapper can handle an object value during document parsing.

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

checkIncomingMergeType, copyTo, doValidate, doXContentBody, executeScript, getTotalFieldsCount, hasScript, ignoreMalformed, indexScriptValues, iterator, merge, multiFields, multiFieldsIterator, name, notInMultiFields, parsesArrayValue, sourcePathUsedBy, toXContent, typeName, validate

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

freezeAndDeduplicateFieldType, internFieldName, simpleName, syntheticFieldLoader, 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

indexAnalyzers

public Map<String,NamedAnalyzer> indexAnalyzers()

Overrides:

indexAnalyzers in class FieldMapper

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

fieldType

public SparseVectorFieldMapper.SparseVectorFieldType fieldType()

Overrides:

fieldType in class FieldMapper

supportsParsingObject

protected boolean supportsParsingObject()

Description copied from class: FieldMapper

Whether this mapper can handle an object value during document parsing. When the subobjects property is set to false, and we encounter an object while parsing we need a way to understand if its fieldMapper is able to parse an object. If that's the case we can provide the entire object to the FieldMapper otherwise its name becomes the part of the dotted field name of each internal value.

Overrides:

supportsParsingObject in class FieldMapper

parse

public void parse(DocumentParserContext context)
           throws IOException

Description copied from class: FieldMapper

Parse the field value using the provided DocumentParserContext.

Overrides:

parse in class FieldMapper

Throws:

IOException

parseCreateField

protected void parseCreateField(DocumentParserContext context)

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

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper