Package org.opensearch.index.mapper

Class SearchAsYouTypeFieldMapper

java.lang.Object

org.opensearch.index.mapper.Mapper

org.opensearch.index.mapper.FieldMapper

org.opensearch.index.mapper.ParametrizedFieldMapper

org.opensearch.index.mapper.SearchAsYouTypeFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment

public class SearchAsYouTypeFieldMapper
extends ParametrizedFieldMapper

Mapper for a text field that optimizes itself for as-you-type completion by indexing its content into subfields. Each subfield modifies the analysis chain of the root field to index terms the user would create as they type out the value in the root field

The structure of these fields is

     [ SearchAsYouTypeFieldMapper, SearchAsYouTypeFieldType, unmodified analysis ]
     ├── [ ShingleFieldMapper, ShingleFieldType, analysis wrapped with 2-shingles ]
     ├── ...
     ├── [ ShingleFieldMapper, ShingleFieldType, analysis wrapped with max_shingle_size-shingles ]
     └── [ PrefixFieldMapper, PrefixFieldType, analysis wrapped with max_shingle_size-shingles and edge-ngrams ]
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchAsYouTypeFieldMapper.Builder
static class	SearchAsYouTypeFieldMapper.Defaults

Nested classes/interfaces inherited from class org.opensearch.index.mapper.ParametrizedFieldMapper

ParametrizedFieldMapper.Parameter<T>, ParametrizedFieldMapper.Serializer<T>, ParametrizedFieldMapper.SerializerCheck<T>, ParametrizedFieldMapper.TypeParser

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

FieldMapper.CopyTo, FieldMapper.MultiFields

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

Mapper.BuilderContext

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Field Summary

Fields

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

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

COERCE_SETTING, copyTo, fieldType, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SearchAsYouTypeFieldMapper(String simpleName, org.opensearch.index.mapper.SearchAsYouTypeFieldMapper.SearchAsYouTypeFieldType mappedFieldType, FieldMapper.CopyTo copyTo, org.opensearch.index.mapper.SearchAsYouTypeFieldMapper.PrefixFieldMapper prefixField, org.opensearch.index.mapper.SearchAsYouTypeFieldMapper.ShingleFieldMapper[] shingleFields, SearchAsYouTypeFieldMapper.Builder builder)

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
org.opensearch.index.mapper.SearchAsYouTypeFieldMapper.SearchAsYouTypeFieldType	fieldType()
ParametrizedFieldMapper.Builder	getMergeBuilder()
static String	getShingleFieldName(String parentField, int shingleSize)
Iterator<Mapper>	iterator()
int	maxShingleSize()
protected void	parseCreateField(ParseContext context)
org.opensearch.index.mapper.SearchAsYouTypeFieldMapper.PrefixFieldMapper	prefixField()
org.opensearch.index.mapper.SearchAsYouTypeFieldMapper.ShingleFieldMapper[]	shingleFields()

Methods inherited from class org.opensearch.index.mapper.ParametrizedFieldMapper

doXContentBody, merge, mergeOptions

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

clone, copyTo, createFieldNamesField, docValuesByDefault, doValidate, doXContentAnalyzers, indexedByDefault, indexOptionToString, multiFields, name, parse, parsesArrayValue, storedByDefault, toXContent, typeName, validate

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

hasIndexCreated, simpleName

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

PARSER

public static final ParametrizedFieldMapper.TypeParser PARSER

Constructor Details

SearchAsYouTypeFieldMapper

public SearchAsYouTypeFieldMapper(String simpleName,
 org.opensearch.index.mapper.SearchAsYouTypeFieldMapper.SearchAsYouTypeFieldType mappedFieldType,
 FieldMapper.CopyTo copyTo,
 org.opensearch.index.mapper.SearchAsYouTypeFieldMapper.PrefixFieldMapper prefixField,
 org.opensearch.index.mapper.SearchAsYouTypeFieldMapper.ShingleFieldMapper[] shingleFields,
 SearchAsYouTypeFieldMapper.Builder builder)

Method Details

parseCreateField

protected void parseCreateField(ParseContext context)
                         throws IOException

Specified by:

parseCreateField in class FieldMapper

Throws:

IOException

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

getMergeBuilder

public ParametrizedFieldMapper.Builder getMergeBuilder()

Specified by:

getMergeBuilder in class ParametrizedFieldMapper

getShingleFieldName

public static String getShingleFieldName(String parentField,
 int shingleSize)

fieldType

public org.opensearch.index.mapper.SearchAsYouTypeFieldMapper.SearchAsYouTypeFieldType fieldType()

Overrides:

fieldType in class FieldMapper

maxShingleSize

public int maxShingleSize()

prefixField

public org.opensearch.index.mapper.SearchAsYouTypeFieldMapper.PrefixFieldMapper prefixField()

shingleFields

public org.opensearch.index.mapper.SearchAsYouTypeFieldMapper.ShingleFieldMapper[] shingleFields()

iterator

public Iterator<Mapper> iterator()

Specified by:

iterator in interface Iterable<Mapper>

Overrides:

iterator in class FieldMapper