Package org.elasticsearch.index.mapper

Class BooleanFieldMapper.BooleanFieldType

java.lang.Object

org.apache.lucene.document.FieldType

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.SimpleMappedFieldType

org.elasticsearch.index.mapper.BooleanFieldMapper.BooleanFieldType

All Implemented Interfaces:

org.apache.lucene.index.IndexableFieldType

Enclosing class:

BooleanFieldMapper

public static final class BooleanFieldMapper.BooleanFieldType
extends SimpleMappedFieldType

Nested Class Summary

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

MappedFieldType.Relation

Constructor Summary

Constructors

Modifier	Constructor	Description
	BooleanFieldType()
protected	BooleanFieldType(BooleanFieldMapper.BooleanFieldType ref)

Method Summary

Modifier and Type	Method	Description
MappedFieldType	clone()
DocValueFormat	docValueFormat(java.lang.String format, java.time.ZoneId timeZone)	Return a DocValueFormat that can be used to display and parse values as returned by the fielddata API.
org.apache.lucene.search.Query	existsQuery(QueryShardContext context)
IndexFieldData.Builder	fielddataBuilder(java.lang.String fullyQualifiedIndexName)	Return a fielddata builder for this field
ValuesSourceType	getValuesSourceType()	Returns the ValuesSourceType which supports this field type.
org.apache.lucene.util.BytesRef	indexedValueForSearch(java.lang.Object value)	Returns the indexed value used to construct search "values".
java.lang.Boolean	nullValue()	Returns the value that should be added when JSON null is found, or null if no value should be added
org.apache.lucene.search.Query	rangeQuery(java.lang.Object lowerTerm, java.lang.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.
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
java.lang.Boolean	valueForDisplay(java.lang.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.SimpleMappedFieldType

rangeQuery

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

boost, checkCompatibility, eagerGlobalOrdinals, equals, extractTerm, failIfNoDocValues, failIfNotIndexed, fuzzyQuery, hasDocValues, hashCode, indexAnalyzer, intervals, isAggregatable, isFieldWithinQuery, isSearchable, meta, multiPhraseQuery, name, nullValueAsString, phrasePrefixQuery, phraseQuery, prefixQuery, regexpQuery, searchAnalyzer, searchQuoteAnalyzer, setBoost, setEagerGlobalOrdinals, setHasDocValues, setIndexAnalyzer, setMeta, setName, setNullValue, setSearchAnalyzer, setSearchQuoteAnalyzer, setSimilarity, similarity, spanPrefixQuery, wildcardQuery

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

checkIfFrozen, docValuesType, freeze, getAttributes, indexOptions, omitNorms, pointDimensionCount, 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 Details

BooleanFieldType

public BooleanFieldType()

BooleanFieldType

protected BooleanFieldType(BooleanFieldMapper.BooleanFieldType ref)

Method Details

clone

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

existsQuery

public org.apache.lucene.search.Query existsQuery(QueryShardContext context)

Specified by:

existsQuery in class MappedFieldType

nullValue

public java.lang.Boolean nullValue()

Description copied from class: MappedFieldType

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

Overrides:

nullValue in class MappedFieldType

indexedValueForSearch

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

valueForDisplay

public java.lang.Boolean valueForDisplay(java.lang.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

fielddataBuilder

public IndexFieldData.Builder fielddataBuilder(java.lang.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

getValuesSourceType

public ValuesSourceType getValuesSourceType()

Description copied from class: MappedFieldType

Returns the ValuesSourceType which supports this field type. This is tightly coupled to field data and aggregations support, so any implementation that returns a value from MappedFieldType.fielddataBuilder(java.lang.String) should also return a value from here.

Overrides:

getValuesSourceType in class MappedFieldType

Returns:

The appropriate ValuesSourceType for this field type.

docValueFormat

public DocValueFormat docValueFormat(@Nullable java.lang.String format, java.time.ZoneId timeZone)

Description copied from class: MappedFieldType

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.

Overrides:

docValueFormat in class MappedFieldType

rangeQuery

public org.apache.lucene.search.Query rangeQuery(java.lang.Object lowerTerm, java.lang.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 SimpleMappedFieldType

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