Package org.elasticsearch.index.mapper

Class CompletionFieldMapper.CompletionFieldType

java.lang.Object

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.SimpleMappedFieldType

org.elasticsearch.index.mapper.TermBasedFieldType

org.elasticsearch.index.mapper.CompletionFieldMapper.CompletionFieldType

Enclosing class:

CompletionFieldMapper

public static final class CompletionFieldMapper.CompletionFieldType
extends TermBasedFieldType

Nested Class Summary

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

MappedFieldType.CollapseType, MappedFieldType.Relation

Constructor Summary

Constructors

Constructor	Description
CompletionFieldType(String name, NamedAnalyzer searchAnalyzer, Map<String,String> meta)

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.search.suggest.document.CompletionQuery	fuzzyQuery(String value, Fuzziness fuzziness, int nonFuzzyPrefixLength, int minFuzzyPrefixLength, int maxExpansions, boolean transpositions, boolean unicodeAware)	Completion prefix fuzzy query
ContextMappings	getContextMappings()
boolean	hasContextMappings()
static org.apache.lucene.codecs.PostingsFormat	postingsFormat()
org.apache.lucene.search.suggest.document.CompletionQuery	prefixQuery(Object value)	Completion prefix query
org.apache.lucene.search.suggest.document.CompletionQuery	regexpQuery(Object value, int flags, int maxDeterminizedStates)	Completion prefix regular expression query
void	setContextMappings(ContextMappings contextMappings)
String	typeName()	Returns the name of this type, as would be specified in mapping properties
ValueFetcher	valueFetcher(SearchExecutionContext context, String format)	Create a helper class to fetch field values during the FetchFieldsPhase.

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

indexedValueForSearch, termQuery, termQueryCaseInsensitive, termsQuery

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

rangeQuery, rangeQuery

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

boost, collapseType, distanceFeatureQuery, docValueFormat, eagerGlobalOrdinals, existsQuery, extractTerm, failIfNoDocValues, failIfNotIndexed, familyTypeName, fielddataBuilder, fuzzyIntervals, fuzzyQuery, getTerms, getTextSearchInfo, hasDocValues, isAggregatable, isFieldWithinQuery, isSearchable, isStored, meta, multiPhraseQuery, name, normalizedWildcardQuery, phrasePrefixQuery, phraseQuery, pointReaderIfPossible, prefixIntervals, prefixQuery, prefixQuery, regexpQuery, setBoost, spanPrefixQuery, termIntervals, valueForDisplay, wildcardIntervals, wildcardQuery, wildcardQuery

Methods inherited from class java.lang.Object

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

Constructor Details

CompletionFieldType

public CompletionFieldType(String name,
 NamedAnalyzer searchAnalyzer,
 Map<String,String> meta)

Method Details

setContextMappings

public void setContextMappings(ContextMappings contextMappings)

hasContextMappings

public boolean hasContextMappings()

Returns:

true if there are one or more context mappings defined for this field type

getContextMappings

public ContextMappings getContextMappings()

Returns:

associated context mappings for this field type

postingsFormat

public static org.apache.lucene.codecs.PostingsFormat postingsFormat()

Returns:

postings format to use for this field-type

prefixQuery

public org.apache.lucene.search.suggest.document.CompletionQuery prefixQuery(Object value)

Completion prefix query

regexpQuery

public org.apache.lucene.search.suggest.document.CompletionQuery regexpQuery(Object value,
 int flags,
 int maxDeterminizedStates)

Completion prefix regular expression query

fuzzyQuery

public org.apache.lucene.search.suggest.document.CompletionQuery fuzzyQuery(String value,
 Fuzziness fuzziness,
 int nonFuzzyPrefixLength,
 int minFuzzyPrefixLength,
 int maxExpansions,
 boolean transpositions,
 boolean unicodeAware)

Completion prefix fuzzy query

typeName

public String typeName()

Description copied from class: MappedFieldType

Returns the name of this type, as would be specified in mapping properties

Specified by:

typeName in class MappedFieldType

valueFetcher

public ValueFetcher valueFetcher(SearchExecutionContext context,
 String format)

Description copied from class: MappedFieldType

Create a helper class to fetch field values during the FetchFieldsPhase.

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 class MappedFieldType