org.elasticsearch.index.mapper

Class MappedFieldType

java.lang.Object

org.apache.lucene.document.FieldType

org.elasticsearch.index.mapper.MappedFieldType

All Implemented Interfaces:

org.apache.lucene.index.IndexableFieldType

Direct Known Subclasses:

BaseGeoPointFieldMapper.GeoPointFieldType, BooleanFieldMapper.BooleanFieldType, CompletionFieldMapper.CompletionFieldType, FieldNamesFieldMapper.FieldNamesFieldType, GeoShapeFieldMapper.GeoShapeFieldType, NumberFieldMapper.NumberFieldType, StringFieldMapper.StringFieldType

public abstract class MappedFieldType
extends org.apache.lucene.document.FieldType

This defines the core properties and functions to operate on a field.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MappedFieldType.Loading
static class	MappedFieldType.Names

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

org.apache.lucene.document.FieldType.NumericType

Constructor Summary

Constructors

Modifier	Constructor and Description
	MappedFieldType()
protected	MappedFieldType(MappedFieldType ref)

Method Summary

Methods

Modifier and Type	Method and Description
float	boost()
void	checkCompatibility(MappedFieldType other, List<String> conflicts, boolean strict) Checks for any conflicts between this field type and other.
abstract MappedFieldType	clone()
protected org.apache.lucene.index.Term	createTerm(Object value) Creates a term associated with the field of this mapper for the given value.
boolean	equals(Object o)
FieldDataType	fieldDataType()
org.apache.lucene.search.Query	fuzzyQuery(Object value, Fuzziness fuzziness, int prefixLength, int maxExpansions, boolean transpositions)
boolean	hasDocValues()
int	hashCode()
NamedAnalyzer	indexAnalyzer()
org.apache.lucene.util.BytesRef	indexedValueForSearch(Object value) Returns the indexed value used to construct search "values".
boolean	isNumeric()
boolean	isSortable()
MappedFieldType.Names	names()
MappedFieldType.Loading	normsLoading()
Object	nullValue() Returns the value that should be added when JSON null is found, or null if no value should be added
String	nullValueAsString() Returns the null value stringified, so it can be used for e.g.
org.apache.lucene.search.Query	nullValueQuery()
org.apache.lucene.search.Query	prefixQuery(String value, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, QueryParseContext context)
org.apache.lucene.search.Query	queryStringTermQuery(org.apache.lucene.index.Term term) A term query to use when parsing a query string.
org.apache.lucene.search.Query	rangeQuery(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper)
org.apache.lucene.search.Query	regexpQuery(String value, int flags, int maxDeterminizedStates, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, QueryParseContext context)
NamedAnalyzer	searchAnalyzer()
NamedAnalyzer	searchQuoteAnalyzer()
void	setBoost(float boost)
void	setFieldDataType(FieldDataType fieldDataType)
void	setHasDocValues(boolean hasDocValues)
void	setIndexAnalyzer(NamedAnalyzer analyzer)
void	setNames(MappedFieldType.Names names)
void	setNormsLoading(MappedFieldType.Loading normsLoading)
void	setNullValue(Object nullValue) Sets the null value and initializes the string version
void	setSearchAnalyzer(NamedAnalyzer analyzer)
void	setSearchQuoteAnalyzer(NamedAnalyzer analyzer)
void	setSimilarity(SimilarityProvider similarity)
SimilarityProvider	similarity()
FieldStats	stats(org.apache.lucene.index.Terms terms, int maxDoc)
org.apache.lucene.search.Query	termQuery(Object value, QueryParseContext context)
org.apache.lucene.search.Query	termsQuery(List values, QueryParseContext context)
abstract String	typeName() Returns the name of this type, as would be specified in mapping properties
boolean	useTermQueryWithQueryString() Should the field query termQuery(Object, org.elasticsearch.index.query.QueryParseContext) be used when detecting this field in query string.
Object	value(Object value) Returns the actual value of the field.
Object	valueForSearch(Object value) Returns the value that will be used as a result for search.

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

checkIfFrozen, docValuesType, freeze, indexOptions, numericPrecisionStep, numericType, omitNorms, 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

MappedFieldType

protected MappedFieldType(MappedFieldType ref)

MappedFieldType

public MappedFieldType()

Method Detail

clone

public abstract MappedFieldType clone()

Overrides:

clone in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class org.apache.lucene.document.FieldType

hashCode

public int hashCode()

Overrides:

hashCode in class org.apache.lucene.document.FieldType

typeName

public abstract String typeName()

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

checkCompatibility

public void checkCompatibility(MappedFieldType other,
                      List<String> conflicts,
                      boolean strict)

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.

isNumeric

public boolean isNumeric()

isSortable

public boolean isSortable()

names

public MappedFieldType.Names names()

setNames

public void setNames(MappedFieldType.Names names)

boost

public float boost()

setBoost

public void setBoost(float boost)

fieldDataType

public FieldDataType fieldDataType()

setFieldDataType

public void setFieldDataType(FieldDataType fieldDataType)

hasDocValues

public boolean hasDocValues()

setHasDocValues

public void setHasDocValues(boolean hasDocValues)

normsLoading

public MappedFieldType.Loading normsLoading()

setNormsLoading

public void setNormsLoading(MappedFieldType.Loading normsLoading)

indexAnalyzer

public NamedAnalyzer indexAnalyzer()

setIndexAnalyzer

public void setIndexAnalyzer(NamedAnalyzer analyzer)

searchAnalyzer

public NamedAnalyzer searchAnalyzer()

setSearchAnalyzer

public void setSearchAnalyzer(NamedAnalyzer analyzer)

searchQuoteAnalyzer

public NamedAnalyzer searchQuoteAnalyzer()

setSearchQuoteAnalyzer

public void setSearchQuoteAnalyzer(NamedAnalyzer analyzer)

similarity

public SimilarityProvider similarity()

setSimilarity

public void setSimilarity(SimilarityProvider similarity)

nullValue

public Object nullValue()

Returns the value that should be added when JSON null is found, or null if no value should be added

nullValueAsString

public String nullValueAsString()

Returns the null value stringified, so it can be used for e.g. _all field, or null if there is no null value

setNullValue

public void setNullValue(Object nullValue)

Sets the null value and initializes the string version

value

public Object value(Object value)

Returns the actual value of the field.

valueForSearch

public Object valueForSearch(Object value)

Returns the value that will be used as a result for search. Can be only of specific types...

indexedValueForSearch

public org.apache.lucene.util.BytesRef indexedValueForSearch(Object value)

Returns the indexed value used to construct search "values".

useTermQueryWithQueryString

public boolean useTermQueryWithQueryString()

Should the field query termQuery(Object, org.elasticsearch.index.query.QueryParseContext) be used when detecting this field in query string.

createTerm

protected org.apache.lucene.index.Term createTerm(Object value)

Creates a term associated with the field of this mapper for the given value. Its important to use termQuery when building term queries because things like ParentFieldMapper override it to make more interesting queries.

termQuery

public org.apache.lucene.search.Query termQuery(Object value,
                                       @Nullable
                                       QueryParseContext context)

termsQuery

public org.apache.lucene.search.Query termsQuery(List values,
                                        @Nullable
                                        QueryParseContext context)

rangeQuery

public org.apache.lucene.search.Query rangeQuery(Object lowerTerm,
                                        Object upperTerm,
                                        boolean includeLower,
                                        boolean includeUpper)

fuzzyQuery

public org.apache.lucene.search.Query fuzzyQuery(Object value,
                                        Fuzziness fuzziness,
                                        int prefixLength,
                                        int maxExpansions,
                                        boolean transpositions)

prefixQuery

public org.apache.lucene.search.Query prefixQuery(String value,
                                         @Nullable
                                         org.apache.lucene.search.MultiTermQuery.RewriteMethod method,
                                         @Nullable
                                         QueryParseContext context)

regexpQuery

public org.apache.lucene.search.Query regexpQuery(String value,
                                         int flags,
                                         int maxDeterminizedStates,
                                         @Nullable
                                         org.apache.lucene.search.MultiTermQuery.RewriteMethod method,
                                         @Nullable
                                         QueryParseContext context)

nullValueQuery

public org.apache.lucene.search.Query nullValueQuery()

stats

public FieldStats stats(org.apache.lucene.index.Terms terms,
               int maxDoc)
                 throws IOException

Returns:

a FieldStats instance that maps to the type of this field based on the provided Terms instance.

Throws:

IOException

queryStringTermQuery

@Nullable
public org.apache.lucene.search.Query queryStringTermQuery(org.apache.lucene.index.Term term)

A term query to use when parsing a query string. Can return null.