Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class TextFamilyFieldType

java.lang.Object

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.SimpleMappedFieldType

org.elasticsearch.index.mapper.TermBasedFieldType

org.elasticsearch.index.mapper.StringFieldType

org.elasticsearch.index.mapper.TextFamilyFieldType

Direct Known Subclasses:

KeywordFieldMapper.KeywordFieldType, TextFieldMapper.TextFieldType

public abstract class TextFamilyFieldType
extends StringFieldType

This is a quality of life class that adds synthetic source context for text fields that need it.

Nested Class Summary

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

MappedFieldType.BlockLoaderContext, MappedFieldType.CollapseType, MappedFieldType.FielddataOperation, MappedFieldType.FieldExtractPreference, MappedFieldType.Relation

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FALLBACK_FIELD_NAME_SUFFIX

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

textSearchInfo

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

indexType

Constructor Summary

Constructors

Constructor	Description
TextFamilyFieldType(String name, IndexType indexType, boolean isStored, TextSearchInfo textSearchInfo, Map<String,String> meta, boolean isSyntheticSourceEnabled, boolean isWithinMultiField)

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.queries.intervals.IntervalsSource	fuzzyIntervals(String term, int maxDistance, int prefixLength, boolean transpositions, SearchExecutionContext context)	Create a fuzzy IntervalsSource for the given term.
boolean	isSyntheticSourceEnabled()
boolean	isWithinMultiField()
org.apache.lucene.queries.intervals.IntervalsSource	prefixIntervals(org.apache.lucene.util.BytesRef prefix, SearchExecutionContext context)	Create an IntervalsSource for the given prefix.
org.apache.lucene.queries.intervals.IntervalsSource	rangeIntervals(org.apache.lucene.util.BytesRef lowerTerm, org.apache.lucene.util.BytesRef upperTerm, boolean includeLower, boolean includeUpper, SearchExecutionContext context)	Create a range IntervalsSource for the given ranges
org.apache.lucene.queries.intervals.IntervalsSource	regexpIntervals(org.apache.lucene.util.BytesRef pattern, SearchExecutionContext context)	Create a regexp IntervalsSource for the given pattern.
String	syntheticSourceFallbackFieldName()	Returns the name of the "fallback" field that can be used for synthetic source when the "main" field was not stored for whatever reason.
org.apache.lucene.queries.intervals.IntervalsSource	termIntervals(org.apache.lucene.util.BytesRef term, SearchExecutionContext context)	Create an IntervalsSource for the given term.
org.apache.lucene.queries.intervals.IntervalsSource	wildcardIntervals(org.apache.lucene.util.BytesRef pattern, SearchExecutionContext context)	Create a wildcard IntervalsSource for the given pattern.

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

fuzzyQuery, normalizedWildcardQuery, normalizeWildcardPattern, prefixQuery, rangeQuery, regexpQuery, wildcardQuery, wildcardQuery

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

getTextSearchInfo, indexedValueForSearch, mayExistInIndex, termQuery, termQueryCaseInsensitive, termsQuery

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

rangeQuery

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

automatonQuery, blockLoader, checkNoFormat, checkNoTimeZone, collapseType, dimensions, distanceFeatureQuery, docValueFormat, eagerGlobalOrdinals, existsQuery, failIfNoDocValues, failIfNotIndexed, failIfNotIndexedNorDocValuesFallback, familyTypeName, fielddataBuilder, fieldHasValue, fuzzyQuery, getDefaultHighlighter, getMetricType, getTerms, hasDocValues, hasScriptValues, indexType, isAggregatable, isDimension, isFieldWithinQuery, isSearchable, isStored, isVectorEmbedding, meta, multiPhraseQuery, name, phrasePrefixQuery, phraseQuery, pointReaderIfPossible, prefixQuery, spanPrefixQuery, supportsBlockLoaderConfig, typeName, validateMatchedRoutingPath, valueFetcher, valueForDisplay, wildcardLikeQuery, wildcardQuery

Methods inherited from class java.lang.Object

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

Field Details

FALLBACK_FIELD_NAME_SUFFIX

public static final String FALLBACK_FIELD_NAME_SUFFIX

See Also:

• Constant Field Values

Constructor Details

TextFamilyFieldType

public TextFamilyFieldType(String name,
 IndexType indexType,
 boolean isStored,
 TextSearchInfo textSearchInfo,
 Map<String,String> meta,
 boolean isSyntheticSourceEnabled,
 boolean isWithinMultiField)

Method Details

isSyntheticSourceEnabled

public boolean isSyntheticSourceEnabled()

isWithinMultiField

public boolean isWithinMultiField()

syntheticSourceFallbackFieldName

public String syntheticSourceFallbackFieldName()

Returns the name of the "fallback" field that can be used for synthetic source when the "main" field was not stored for whatever reason.

termIntervals

public org.apache.lucene.queries.intervals.IntervalsSource termIntervals(org.apache.lucene.util.BytesRef term,
 SearchExecutionContext context)

Create an IntervalsSource for the given term.

prefixIntervals

public org.apache.lucene.queries.intervals.IntervalsSource prefixIntervals(org.apache.lucene.util.BytesRef prefix,
 SearchExecutionContext context)

Create an IntervalsSource for the given prefix.

fuzzyIntervals

public org.apache.lucene.queries.intervals.IntervalsSource fuzzyIntervals(String term,
 int maxDistance,
 int prefixLength,
 boolean transpositions,
 SearchExecutionContext context)

Create a fuzzy IntervalsSource for the given term.

wildcardIntervals

public org.apache.lucene.queries.intervals.IntervalsSource wildcardIntervals(org.apache.lucene.util.BytesRef pattern,
 SearchExecutionContext context)

Create a wildcard IntervalsSource for the given pattern.

regexpIntervals

public org.apache.lucene.queries.intervals.IntervalsSource regexpIntervals(org.apache.lucene.util.BytesRef pattern,
 SearchExecutionContext context)

Create a regexp IntervalsSource for the given pattern.

rangeIntervals

public org.apache.lucene.queries.intervals.IntervalsSource rangeIntervals(org.apache.lucene.util.BytesRef lowerTerm,
 org.apache.lucene.util.BytesRef upperTerm,
 boolean includeLower,
 boolean includeUpper,
 SearchExecutionContext context)

Create a range IntervalsSource for the given ranges