Package org.elasticsearch.index.mapper

Class KeywordFieldMapper.KeywordFieldType

java.lang.Object

org.apache.lucene.document.FieldType

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.SimpleMappedFieldType

org.elasticsearch.index.mapper.StringFieldType

org.elasticsearch.index.mapper.KeywordFieldMapper.KeywordFieldType

All Implemented Interfaces:

IndexableFieldType

Enclosing class:

KeywordFieldMapper

public static final class KeywordFieldMapper.KeywordFieldType
extends StringFieldType

Nested Class Summary

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

MappedFieldType.Relation

Constructor Summary

Constructors

Modifier	Constructor	Description
	KeywordFieldType()
protected	KeywordFieldType(KeywordFieldMapper.KeywordFieldType ref)

Method Summary

Modifier and Type	Method	Description
void	checkCompatibility(MappedFieldType otherFT, List<String> conflicts)	Checks for any conflicts between this field type and other.
KeywordFieldMapper.KeywordFieldType	clone()
boolean	equals(Object o)
Query	existsQuery(QueryShardContext context)
IndexFieldData.Builder	fielddataBuilder(String fullyQualifiedIndexName)	Return a fielddata builder for this field
int	hashCode()
protected BytesRef	indexedValueForSearch(Object value)	Returns the indexed value used to construct search "values".
void	setNormalizer(NamedAnalyzer normalizer)
void	setSplitQueriesOnWhitespace(boolean splitQueriesOnWhitespace)
boolean	splitQueriesOnWhitespace()
Query	termQuery(Object value, QueryShardContext context)	Generates a query that will only match documents that contain the given value.
String	typeName()	Returns the name of this type, as would be specified in mapping properties
Object	valueForDisplay(Object value)	Given a value that comes from the stored fields API, convert it to the expected type.

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

fuzzyQuery, prefixQuery, rangeQuery, regexpQuery, termsQuery, wildcardQuery

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

rangeQuery

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

boost, docValueFormat, eagerGlobalOrdinals, extractTerm, failIfNoDocValues, failIfNotIndexed, hasDocValues, indexAnalyzer, intervals, isAggregatable, isFieldWithinQuery, isSearchable, multiPhraseQuery, name, nullValue, nullValueAsString, phrasePrefixQuery, phraseQuery, searchAnalyzer, searchQuoteAnalyzer, setBoost, setEagerGlobalOrdinals, setHasDocValues, setIndexAnalyzer, setName, setNullValue, setSearchAnalyzer, setSearchQuoteAnalyzer, setSimilarity, similarity, spanPrefixQuery

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

checkIfFrozen, docValuesType, freeze, getAttributes, indexOptions, omitNorms, pointDataDimensionCount, pointIndexDimensionCount, pointNumBytes, putAttribute, setDimensions, setDimensions, setDocValuesType, setIndexOptions, 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

KeywordFieldType

public KeywordFieldType()

KeywordFieldType

protected KeywordFieldType(KeywordFieldMapper.KeywordFieldType ref)

Method Detail

clone

public KeywordFieldMapper.KeywordFieldType clone()

Specified by:

clone in class MappedFieldType

equals

public boolean equals(Object o)

Overrides:

equals in class MappedFieldType

checkCompatibility

public void checkCompatibility(MappedFieldType otherFT,
                               List<String> conflicts)

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

hashCode

public int hashCode()

Overrides:

hashCode in class MappedFieldType

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

setNormalizer

public void setNormalizer(NamedAnalyzer normalizer)

splitQueriesOnWhitespace

public boolean splitQueriesOnWhitespace()

setSplitQueriesOnWhitespace

public void setSplitQueriesOnWhitespace(boolean splitQueriesOnWhitespace)

existsQuery

public Query existsQuery(QueryShardContext context)

Specified by:

existsQuery in class MappedFieldType

fielddataBuilder

public IndexFieldData.Builder fielddataBuilder(String fullyQualifiedIndexName)

Description copied from class: MappedFieldType

Return a fielddata builder for this field

Overrides:

fielddataBuilder in class MappedFieldType

Parameters:

fullyQualifiedIndexName - the name of the index this field-data is build for

valueForDisplay

public Object valueForDisplay(Object value)

Description copied from class: MappedFieldType

Given a value that comes from the stored fields API, convert it to the expected type. For instance a date field would store dates as longs and format it back to a string in this method.

Overrides:

valueForDisplay in class MappedFieldType

indexedValueForSearch

protected BytesRef indexedValueForSearch(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 MappedFieldType.termQuery(java.lang.Object, org.elasticsearch.index.query.QueryShardContext).

termQuery

public Query termQuery(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