Package org.elasticsearch.index.mapper
Class TextFieldMapper.TextFieldType
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.TextFieldMapper.TextFieldType
- Enclosing class:
- TextFieldMapper
public static class TextFieldMapper.TextFieldType extends StringFieldType
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.MappedFieldType
MappedFieldType.CollapseType, MappedFieldType.Relation
-
Constructor Summary
Constructors Constructor Description TextFieldType(java.lang.String name)
TextFieldType(java.lang.String name, boolean indexed, boolean stored, java.util.Map<java.lang.String,java.lang.String> meta)
TextFieldType(java.lang.String name, boolean indexed, boolean stored, TextSearchInfo tsi, java.util.Map<java.lang.String,java.lang.String> meta)
-
Method Summary
Modifier and Type Method Description boolean
eagerGlobalOrdinals()
boolean
fielddata()
IndexFieldData.Builder
fielddataBuilder(java.lang.String fullyQualifiedIndexName, java.util.function.Supplier<SearchLookup> searchLookup)
Return a fielddata builder for this fieldorg.elasticsearch.index.mapper.TextFieldMapper.PrefixFieldType
getPrefixFieldType()
static boolean
hasGaps(org.apache.lucene.analysis.TokenStream stream)
org.apache.lucene.queries.intervals.IntervalsSource
intervals(java.lang.String text, int maxGaps, boolean ordered, NamedAnalyzer analyzer, boolean prefix)
Create anIntervalsSource
to be used for proximity queriesorg.apache.lucene.search.Query
multiPhraseQuery(org.apache.lucene.analysis.TokenStream stream, int slop, boolean enablePositionIncrements)
org.apache.lucene.search.Query
phrasePrefixQuery(org.apache.lucene.analysis.TokenStream stream, int slop, int maxExpansions)
org.apache.lucene.search.Query
phraseQuery(org.apache.lucene.analysis.TokenStream stream, int slop, boolean enablePosIncrements)
org.apache.lucene.search.Query
prefixQuery(java.lang.String value, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, boolean caseInsensitive, SearchExecutionContext context)
void
setFielddata(boolean fielddata)
void
setFielddata(boolean fielddata, org.elasticsearch.index.mapper.TextFieldMapper.FielddataFrequencyFilter filter)
org.apache.lucene.search.spans.SpanQuery
spanPrefixQuery(java.lang.String value, org.apache.lucene.search.spans.SpanMultiTermQueryWrapper.SpanRewriteMethod method, SearchExecutionContext context)
java.lang.String
typeName()
Returns the name of this type, as would be specified in mapping propertiesValueFetcher
valueFetcher(SearchExecutionContext context, java.lang.String format)
Create a helper class to fetch field values during theFetchFieldsPhase
.Methods inherited from class org.elasticsearch.index.mapper.StringFieldType
fuzzyQuery, normalizedWildcardQuery, normalizeWildcardPattern, rangeQuery, regexpQuery, wildcardQuery, wildcardQuery
Methods inherited from class org.elasticsearch.index.mapper.TermBasedFieldType
indexedValueForSearch, termQuery, termQueryCaseInsensitive, termsQuery
Methods inherited from class org.elasticsearch.index.mapper.SimpleMappedFieldType
rangeQuery
Methods inherited from class org.elasticsearch.index.mapper.MappedFieldType
boost, collapseType, distanceFeatureQuery, docValueFormat, existsQuery, extractTerm, failIfNoDocValues, failIfNotIndexed, familyTypeName, getTextSearchInfo, hasDocValues, isAggregatable, isFieldWithinQuery, isSearchable, isStored, meta, name, pointReaderIfPossible, prefixQuery, setBoost, valueForDisplay, wildcardQuery
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
TextFieldType
public TextFieldType(java.lang.String name, boolean indexed, boolean stored, TextSearchInfo tsi, java.util.Map<java.lang.String,java.lang.String> meta) -
TextFieldType
public TextFieldType(java.lang.String name, boolean indexed, boolean stored, java.util.Map<java.lang.String,java.lang.String> meta) -
TextFieldType
public TextFieldType(java.lang.String name)
-
-
Method Details
-
fielddata
public boolean fielddata() -
eagerGlobalOrdinals
public boolean eagerGlobalOrdinals()- Overrides:
eagerGlobalOrdinals
in classMappedFieldType
- Returns:
- if this field type should load global ordinals eagerly
-
setFielddata
public void setFielddata(boolean fielddata, org.elasticsearch.index.mapper.TextFieldMapper.FielddataFrequencyFilter filter) -
setFielddata
public void setFielddata(boolean fielddata) -
getPrefixFieldType
public org.elasticsearch.index.mapper.TextFieldMapper.PrefixFieldType getPrefixFieldType() -
typeName
public java.lang.String typeName()Description copied from class:MappedFieldType
Returns the name of this type, as would be specified in mapping properties- Specified by:
typeName
in classMappedFieldType
-
valueFetcher
Description copied from class:MappedFieldType
Create a helper class to fetch field values during theFetchFieldsPhase
.New field types must implement this method in order to support the search 'fields' option. Except for metadata fields, field types should not throw
UnsupportedOperationException
since this could cause a search retrieving multiple fields (like "fields": ["*"]) to fail.- Specified by:
valueFetcher
in classMappedFieldType
-
prefixQuery
public org.apache.lucene.search.Query prefixQuery(java.lang.String value, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, boolean caseInsensitive, SearchExecutionContext context)- Overrides:
prefixQuery
in classStringFieldType
-
spanPrefixQuery
public org.apache.lucene.search.spans.SpanQuery spanPrefixQuery(java.lang.String value, org.apache.lucene.search.spans.SpanMultiTermQueryWrapper.SpanRewriteMethod method, SearchExecutionContext context)- Overrides:
spanPrefixQuery
in classMappedFieldType
-
intervals
public org.apache.lucene.queries.intervals.IntervalsSource intervals(java.lang.String text, int maxGaps, boolean ordered, NamedAnalyzer analyzer, boolean prefix) throws java.io.IOExceptionDescription copied from class:MappedFieldType
Create anIntervalsSource
to be used for proximity queries- Overrides:
intervals
in classMappedFieldType
- Throws:
java.io.IOException
-
phraseQuery
public org.apache.lucene.search.Query phraseQuery(org.apache.lucene.analysis.TokenStream stream, int slop, boolean enablePosIncrements) throws java.io.IOException- Overrides:
phraseQuery
in classMappedFieldType
- Throws:
java.io.IOException
-
multiPhraseQuery
public org.apache.lucene.search.Query multiPhraseQuery(org.apache.lucene.analysis.TokenStream stream, int slop, boolean enablePositionIncrements) throws java.io.IOException- Overrides:
multiPhraseQuery
in classMappedFieldType
- Throws:
java.io.IOException
-
phrasePrefixQuery
public org.apache.lucene.search.Query phrasePrefixQuery(org.apache.lucene.analysis.TokenStream stream, int slop, int maxExpansions) throws java.io.IOException- Overrides:
phrasePrefixQuery
in classMappedFieldType
- Throws:
java.io.IOException
-
hasGaps
public static boolean hasGaps(org.apache.lucene.analysis.TokenStream stream) throws java.io.IOException- Throws:
java.io.IOException
-
fielddataBuilder
public IndexFieldData.Builder fielddataBuilder(java.lang.String fullyQualifiedIndexName, java.util.function.Supplier<SearchLookup> searchLookup)Description copied from class:MappedFieldType
Return a fielddata builder for this field- Overrides:
fielddataBuilder
in classMappedFieldType
- Parameters:
fullyQualifiedIndexName
- the name of the index this field-data is build forsearchLookup
- aSearchLookup
supplier to allow for accessing other fields values in the context of runtime fields
-