Package org.elasticsearch.index.mapper

Class TypeFieldMapper.TypeFieldType

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.TypeFieldMapper.TypeFieldType

All Implemented Interfaces:

IndexableFieldType

Enclosing class:

TypeFieldMapper

public static final class TypeFieldMapper.TypeFieldType
extends StringFieldType

Nested Class Summary

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

MappedFieldType.Relation

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TypeFieldType(TypeFieldMapper.TypeFieldType ref)

Method Summary

Modifier and Type	Method	Description
MappedFieldType	clone()
Query	existsQuery(QueryShardContext context)
IndexFieldData.Builder	fielddataBuilder(String fullyQualifiedIndexName)	Return a fielddata builder for this field
protected BytesRef	indexedValueForSearch(Object value)	Returns the indexed value used to construct search "values".
boolean	isSearchable()	Returns true if the field is searchable.
Query	rangeQuery(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, QueryShardContext context)	Same as SimpleMappedFieldType.rangeQuery(Object, Object, boolean, boolean, ShapeRelation, ZoneId, DateMathParser, QueryShardContext) but without the trouble of relations or date-specific options.
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.
String	typeName()	Returns the name of this type, as would be specified in mapping properties

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

fuzzyQuery, prefixQuery, regexpQuery, wildcardQuery

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

rangeQuery

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

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

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

TypeFieldType

protected TypeFieldType(TypeFieldMapper.TypeFieldType ref)

Method Detail

clone

public MappedFieldType clone()

Specified by:

clone 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

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

isSearchable

public boolean isSearchable()

Description copied from class: MappedFieldType

Returns true if the field is searchable.

Overrides:

isSearchable in class MappedFieldType

existsQuery

public Query existsQuery(QueryShardContext context)

Specified by:

existsQuery in class MappedFieldType

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

termsQuery

public Query termsQuery(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 StringFieldType

rangeQuery

public Query rangeQuery(Object lowerTerm,
                        Object upperTerm,
                        boolean includeLower,
                        boolean includeUpper,
                        QueryShardContext context)

Description copied from class: SimpleMappedFieldType

Same as SimpleMappedFieldType.rangeQuery(Object, Object, boolean, boolean, ShapeRelation, ZoneId, DateMathParser, QueryShardContext) but without the trouble of relations or date-specific options.

Overrides:

rangeQuery in class StringFieldType

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