Package org.elasticsearch.index.mapper

Class MappedFieldType

java.lang.Object

org.apache.lucene.document.FieldType

org.elasticsearch.index.mapper.MappedFieldType

All Implemented Interfaces:

IndexableFieldType

Direct Known Subclasses:

AbstractGeometryFieldMapper.AbstractGeometryFieldType, DateFieldMapper.DateFieldType, GeoPointFieldMapper.GeoPointFieldType, RangeFieldMapper.RangeFieldType, SimpleMappedFieldType

public abstract class MappedFieldType
extends FieldType

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MappedFieldType.Relation	An enum used to describe the relation between the range of terms in a shard when compared with a query range

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
float	boost()
void	checkCompatibility(MappedFieldType other, List<String> conflicts)	Checks for any conflicts between this field type and other.
abstract MappedFieldType	clone()
DocValueFormat	docValueFormat(String format, ZoneId timeZone)	Return a DocValueFormat that can be used to display and parse values as returned by the fielddata API.
boolean	eagerGlobalOrdinals()
boolean	equals(Object o)
abstract Query	existsQuery(QueryShardContext context)
static Term	extractTerm(Query termQuery)	Extract a Term from a query created with termQuery(java.lang.Object, org.elasticsearch.index.query.QueryShardContext) by recursively removing BoostQuery wrappers.
protected void	failIfNoDocValues()
protected void	failIfNotIndexed()
IndexFieldData.Builder	fielddataBuilder(String fullyQualifiedIndexName)	Return a fielddata builder for this field
Query	fuzzyQuery(Object value, Fuzziness fuzziness, int prefixLength, int maxExpansions, boolean transpositions)
boolean	hasDocValues()
int	hashCode()
NamedAnalyzer	indexAnalyzer()
IntervalsSource	intervals(String query, int max_gaps, boolean ordered, NamedAnalyzer analyzer, boolean prefix)	Create an IntervalsSource to be used for proximity queries
boolean	isAggregatable()	Returns true if the field is aggregatable.
MappedFieldType.Relation	isFieldWithinQuery(IndexReader reader, Object from, Object to, boolean includeLower, boolean includeUpper, ZoneId timeZone, DateMathParser dateMathParser, QueryRewriteContext context)	Return whether all values of the given IndexReader are within the range, outside the range or cross the range.
boolean	isSearchable()	Returns true if the field is searchable.
Query	multiPhraseQuery(TokenStream stream, int slop, boolean enablePositionIncrements)
String	name()
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 or null if there is no null value
Query	phrasePrefixQuery(TokenStream stream, int slop, int maxExpansions)
Query	phraseQuery(TokenStream stream, int slop, boolean enablePositionIncrements)
Query	prefixQuery(String value, MultiTermQuery.RewriteMethod method, QueryShardContext context)
Query	rangeQuery(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, ShapeRelation relation, ZoneId timeZone, DateMathParser parser, QueryShardContext context)	Factory method for range queries.
Query	regexpQuery(String value, int flags, int maxDeterminizedStates, MultiTermQuery.RewriteMethod method, QueryShardContext context)
NamedAnalyzer	searchAnalyzer()
NamedAnalyzer	searchQuoteAnalyzer()
void	setBoost(float boost)
void	setEagerGlobalOrdinals(boolean eagerGlobalOrdinals)
void	setHasDocValues(boolean hasDocValues)
void	setIndexAnalyzer(NamedAnalyzer analyzer)
void	setName(String name)
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()
SpanQuery	spanPrefixQuery(String value, SpanMultiTermQueryWrapper.SpanRewriteMethod method, QueryShardContext context)
abstract Query	termQuery(Object value, QueryShardContext context)	Generates a query that will only match documents that contain the given value.
Query	termsQuery(List<?> values, QueryShardContext context)	Build a constant-scoring query that matches all values.
abstract 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.
Query	wildcardQuery(String value, MultiTermQuery.RewriteMethod method, QueryShardContext context)

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

MappedFieldType

protected MappedFieldType(MappedFieldType ref)

MappedFieldType

public MappedFieldType()

Method Detail

clone

public abstract MappedFieldType clone()

Overrides:

clone in class Object

fielddataBuilder

public IndexFieldData.Builder fielddataBuilder(String fullyQualifiedIndexName)

Return a fielddata builder for this field

Parameters:

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

Throws:

IllegalArgumentException - if the fielddata is not supported on this type. An IllegalArgumentException is needed in order to return an http error 400 when this error occurs in a request. see: ExceptionsHelper.status(java.lang.Throwable)

equals

public boolean equals(Object o)

Overrides:

equals in class FieldType

hashCode

public int hashCode()

Overrides:

hashCode in class 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)

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.

name

public String name()

setName

public void setName(String name)

boost

public float boost()

setBoost

public void setBoost(float boost)

hasDocValues

public boolean hasDocValues()

setHasDocValues

public void setHasDocValues(boolean hasDocValues)

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 or null if there is no null value

setNullValue

public void setNullValue(Object nullValue)

Sets the null value and initializes the string version

valueForDisplay

public Object valueForDisplay(Object value)

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.

isSearchable

public boolean isSearchable()

Returns true if the field is searchable.

isAggregatable

public boolean isAggregatable()

Returns true if the field is aggregatable.

termQuery

public abstract Query termQuery(Object value,
                                @Nullable
                                QueryShardContext context)

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 boost().

Throws:

IllegalArgumentException - if value cannot be converted to the expected data type or if the field is not searchable due to the way it is configured (eg. not indexed)

ElasticsearchParseException - if value cannot be converted to the expected data type

UnsupportedOperationException - if the field is not searchable regardless of options

QueryShardException - if the field is not searchable regardless of options

termsQuery

public Query termsQuery(List<?> values,
                        @Nullable
                        QueryShardContext context)

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

rangeQuery

public Query rangeQuery(Object lowerTerm,
                        Object upperTerm,
                        boolean includeLower,
                        boolean includeUpper,
                        ShapeRelation relation,
                        ZoneId timeZone,
                        DateMathParser parser,
                        QueryShardContext context)

Factory method for range queries.

Parameters:

relation - the relation, nulls should be interpreted like INTERSECTS

fuzzyQuery

public Query fuzzyQuery(Object value,
                        Fuzziness fuzziness,
                        int prefixLength,
                        int maxExpansions,
                        boolean transpositions)

prefixQuery

public Query prefixQuery(String value,
                         @Nullable
                         MultiTermQuery.RewriteMethod method,
                         QueryShardContext context)

wildcardQuery

public Query wildcardQuery(String value,
                           @Nullable
                           MultiTermQuery.RewriteMethod method,
                           QueryShardContext context)

regexpQuery

public Query regexpQuery(String value,
                         int flags,
                         int maxDeterminizedStates,
                         @Nullable
                         MultiTermQuery.RewriteMethod method,
                         QueryShardContext context)

existsQuery

public abstract Query existsQuery(QueryShardContext context)

phraseQuery

public Query phraseQuery(TokenStream stream,
                         int slop,
                         boolean enablePositionIncrements)
                  throws IOException

Throws:

IOException

multiPhraseQuery

public Query multiPhraseQuery(TokenStream stream,
                              int slop,
                              boolean enablePositionIncrements)
                       throws IOException

Throws:

IOException

phrasePrefixQuery

public Query phrasePrefixQuery(TokenStream stream,
                               int slop,
                               int maxExpansions)
                        throws IOException

Throws:

IOException

spanPrefixQuery

public SpanQuery spanPrefixQuery(String value,
                                 SpanMultiTermQueryWrapper.SpanRewriteMethod method,
                                 QueryShardContext context)

intervals

public IntervalsSource intervals(String query,
                                 int max_gaps,
                                 boolean ordered,
                                 NamedAnalyzer analyzer,
                                 boolean prefix)
                          throws IOException

Create an IntervalsSource to be used for proximity queries

Throws:

IOException

isFieldWithinQuery

public MappedFieldType.Relation isFieldWithinQuery(IndexReader reader,
                                                   Object from,
                                                   Object to,
                                                   boolean includeLower,
                                                   boolean includeUpper,
                                                   ZoneId timeZone,
                                                   DateMathParser dateMathParser,
                                                   QueryRewriteContext context)
                                            throws IOException

Return whether all values of the given IndexReader are within the range, outside the range or cross the range. The default implementation returns MappedFieldType.Relation.INTERSECTS, which is always fine to return when there is no way to check whether values are actually within bounds.

Throws:

IOException

failIfNoDocValues

protected final void failIfNoDocValues()

Throws:

IllegalArgumentException - if the fielddata is not supported on this type. An IllegalArgumentException is needed in order to return an http error 400 when this error occurs in a request. see: ExceptionsHelper.status(java.lang.Throwable)

failIfNotIndexed

protected final void failIfNotIndexed()

eagerGlobalOrdinals

public boolean eagerGlobalOrdinals()

setEagerGlobalOrdinals

public void setEagerGlobalOrdinals(boolean eagerGlobalOrdinals)

docValueFormat

public DocValueFormat docValueFormat(@Nullable
                                     String format,
                                     ZoneId timeZone)

Return a DocValueFormat that can be used to display and parse values as returned by the fielddata API. The default implementation returns a DocValueFormat.RAW.

extractTerm

public static Term extractTerm(Query termQuery)

Extract a Term from a query created with termQuery(java.lang.Object, org.elasticsearch.index.query.QueryShardContext) by recursively removing BoostQuery wrappers.

Throws:

IllegalArgumentException - if the wrapped query is not a TermQuery