org.elasticsearch.index.mapper

Class CompletionFieldMapper.CompletionFieldType

java.lang.Object

org.apache.lucene.document.FieldType

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.CompletionFieldMapper.CompletionFieldType

All Implemented Interfaces:

org.apache.lucene.index.IndexableFieldType

Enclosing class:

CompletionFieldMapper

public static final class CompletionFieldMapper.CompletionFieldType
extends MappedFieldType

Nested Class Summary

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

MappedFieldType.Relation

Nested classes/interfaces inherited from class org.apache.lucene.document.FieldType

org.apache.lucene.document.FieldType.LegacyNumericType

Constructor Summary

Constructors

Constructor and Description
CompletionFieldType()

Method Summary

Modifier and Type	Method and Description
void	checkCompatibility(MappedFieldType fieldType, java.util.List<java.lang.String> conflicts, boolean strict) Checks for any conflicts between this field type and other.
CompletionFieldMapper.CompletionFieldType	clone()
boolean	equals(java.lang.Object o)
org.apache.lucene.search.suggest.document.CompletionQuery	fuzzyQuery(java.lang.String value, Fuzziness fuzziness, int nonFuzzyPrefixLength, int minFuzzyPrefixLength, int maxExpansions, boolean transpositions, boolean unicodeAware) Completion prefix fuzzy query
ContextMappings	getContextMappings()
boolean	hasContextMappings()
int	hashCode()
NamedAnalyzer	indexAnalyzer()
protected org.apache.lucene.util.BytesRef	indexedValueForSearch(java.lang.Object value) Returns the indexed value used to construct search "values".
static org.apache.lucene.codecs.PostingsFormat	postingsFormat()
org.apache.lucene.search.suggest.document.CompletionQuery	prefixQuery(java.lang.Object value) Completion prefix query
boolean	preservePositionIncrements()
boolean	preserveSep()
org.apache.lucene.search.suggest.document.CompletionQuery	regexpQuery(java.lang.Object value, int flags, int maxDeterminizedStates) Completion prefix regular expression query
NamedAnalyzer	searchAnalyzer()
void	setContextMappings(ContextMappings contextMappings)
void	setPreservePositionIncrements(boolean preservePositionIncrements)
void	setPreserveSep(boolean preserveSep)
org.apache.lucene.search.Query	termQuery(java.lang.Object value, QueryShardContext context) Generates a query that will only match documents that contain the given value.
org.apache.lucene.search.Query	termsQuery(java.util.List<?> values, QueryShardContext context) Build a constant-scoring query that matches all values.
java.lang.String	typeName() Returns the name of this type, as would be specified in mapping properties

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

boost, docValueFormat, eagerGlobalOrdinals, extractTerm, failIfNoDocValues, failIfNotIndexed, fielddataBuilder, fuzzyQuery, hasDocValues, isAggregatable, isFieldWithinQuery, isSearchable, name, nullValue, nullValueAsString, nullValueQuery, prefixQuery, queryStringTermQuery, rangeQuery, regexpQuery, searchQuoteAnalyzer, setBoost, setEagerGlobalOrdinals, setHasDocValues, setIndexAnalyzer, setName, setNullValue, setSearchAnalyzer, setSearchQuoteAnalyzer, setSimilarity, similarity, stats, valueForDisplay

Methods inherited from class org.apache.lucene.document.FieldType

checkIfFrozen, docValuesType, freeze, indexOptions, numericPrecisionStep, numericType, omitNorms, pointDimensionCount, pointNumBytes, setDimensions, setDocValuesType, setIndexOptions, setNumericPrecisionStep, setNumericType, setOmitNorms, setStored, setStoreTermVectorOffsets, setStoreTermVectorPayloads, setStoreTermVectorPositions, setStoreTermVectors, setTokenized, stored, storeTermVectorOffsets, storeTermVectorPayloads, storeTermVectorPositions, storeTermVectors, tokenized, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CompletionFieldType

public CompletionFieldType()

Method Detail

setPreserveSep

public void setPreserveSep(boolean preserveSep)

setPreservePositionIncrements

public void setPreservePositionIncrements(boolean preservePositionIncrements)

setContextMappings

public void setContextMappings(ContextMappings contextMappings)

indexAnalyzer

public NamedAnalyzer indexAnalyzer()

Overrides:

indexAnalyzer in class MappedFieldType

searchAnalyzer

public NamedAnalyzer searchAnalyzer()

Overrides:

searchAnalyzer in class MappedFieldType

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

preserveSep

public boolean preserveSep()

preservePositionIncrements

public boolean preservePositionIncrements()

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(java.lang.Object value)

Completion prefix query

regexpQuery

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

Completion prefix regular expression query

fuzzyQuery

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

Completion prefix fuzzy query

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class MappedFieldType

hashCode

public int hashCode()

Overrides:

hashCode in class MappedFieldType

clone

public CompletionFieldMapper.CompletionFieldType clone()

Specified by:

clone in class MappedFieldType

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

checkCompatibility

public void checkCompatibility(MappedFieldType fieldType,
                               java.util.List<java.lang.String> conflicts,
                               boolean strict)

Description copied from class: MappedFieldType

Checks for any conflicts between this field type and other. If strict is true, all properties must be equal. Otherwise, only properties which must never change in an index are checked.

Overrides:

checkCompatibility in class MappedFieldType

indexedValueForSearch

protected org.apache.lucene.util.BytesRef indexedValueForSearch(java.lang.Object value)

Returns the indexed value used to construct search "values". This method is used for the default implementations of most query factory methods such as termQuery(java.lang.Object, org.elasticsearch.index.query.QueryShardContext).

termQuery

public org.apache.lucene.search.Query termQuery(java.lang.Object value,
                                                QueryShardContext context)

Description copied from class: MappedFieldType

Generates a query that will only match documents that contain the given value. The default implementation returns a TermQuery over the value bytes, boosted by MappedFieldType.boost().

Specified by:

termQuery in class MappedFieldType

termsQuery

public org.apache.lucene.search.Query termsQuery(java.util.List<?> values,
                                                 QueryShardContext context)

Description copied from class: MappedFieldType

Build a constant-scoring query that matches all values. The default implementation uses a ConstantScoreQuery around a BooleanQuery whose BooleanClause.Occur.SHOULD clauses are generated with MappedFieldType.termQuery(java.lang.Object, org.elasticsearch.index.query.QueryShardContext).

Overrides:

termsQuery in class MappedFieldType