Package org.elasticsearch.index.mapper
Class BooleanFieldMapper.BooleanFieldType
java.lang.Object
org.elasticsearch.index.mapper.MappedFieldType
org.elasticsearch.index.mapper.SimpleMappedFieldType
org.elasticsearch.index.mapper.TermBasedFieldType
org.elasticsearch.index.mapper.BooleanFieldMapper.BooleanFieldType
- Enclosing class:
- BooleanFieldMapper
public static final class BooleanFieldMapper.BooleanFieldType extends TermBasedFieldType
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.MappedFieldType
MappedFieldType.Relation
-
Constructor Summary
Constructors Constructor Description BooleanFieldType(java.lang.String name)
BooleanFieldType(java.lang.String name, boolean searchable)
BooleanFieldType(java.lang.String name, boolean isSearchable, boolean isStored, boolean hasDocValues, java.lang.Boolean nullValue, java.util.Map<java.lang.String,java.lang.String> meta)
-
Method Summary
Modifier and Type Method Description DocValueFormat
docValueFormat(java.lang.String format, java.time.ZoneId timeZone)
Return aDocValueFormat
that can be used to display and parse values as returned by the fielddata API.IndexFieldData.Builder
fielddataBuilder(java.lang.String fullyQualifiedIndexName, java.util.function.Supplier<SearchLookup> searchLookup)
Return a fielddata builder for this fieldorg.apache.lucene.util.BytesRef
indexedValueForSearch(java.lang.Object value)
Returns the indexed value used to construct search "values".org.apache.lucene.search.Query
rangeQuery(java.lang.Object lowerTerm, java.lang.Object upperTerm, boolean includeLower, boolean includeUpper, QueryShardContext context)
Same asSimpleMappedFieldType.rangeQuery(Object, Object, boolean, boolean, ShapeRelation, ZoneId, DateMathParser, QueryShardContext)
but without the trouble of relations or date-specific options.java.lang.String
typeName()
Returns the name of this type, as would be specified in mapping propertiesValueFetcher
valueFetcher(MapperService mapperService, SearchLookup searchLookup, java.lang.String format)
Create a helper class to fetch field values during theFetchFieldsPhase
.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.TermBasedFieldType
termQuery, termQueryCaseInsensitive, termsQuery
Methods inherited from class org.elasticsearch.index.mapper.MappedFieldType
boost, distanceFeatureQuery, eagerGlobalOrdinals, existsQuery, extractTerm, failIfNoDocValues, failIfNotIndexed, familyTypeName, fuzzyQuery, getTextSearchInfo, hasDocValues, indexAnalyzer, intervals, isAggregatable, isFieldWithinQuery, isSearchable, isStored, meta, multiPhraseQuery, name, phrasePrefixQuery, phraseQuery, pointReaderIfPossible, prefixQuery, prefixQuery, regexpQuery, setBoost, setEagerGlobalOrdinals, setIndexAnalyzer, spanPrefixQuery, wildcardQuery, wildcardQuery
-
Constructor Details
-
BooleanFieldType
public BooleanFieldType(java.lang.String name, boolean isSearchable, boolean isStored, boolean hasDocValues, java.lang.Boolean nullValue, java.util.Map<java.lang.String,java.lang.String> meta) -
BooleanFieldType
public BooleanFieldType(java.lang.String name) -
BooleanFieldType
public BooleanFieldType(java.lang.String name, boolean searchable)
-
-
Method Details
-
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 classMappedFieldType
-
valueFetcher
public ValueFetcher valueFetcher(MapperService mapperService, SearchLookup searchLookup, java.lang.String format)Description copied from class:MappedFieldType
Create a helper class to fetch field values during theFetchFieldsPhase
. New field types must implement this method in order to support the search 'fields' option. Except for metadata fields, field types should not throwUnsupportedOperationException
since this could cause a search retrieving multiple fields (like "fields": ["*"]) to fail.- Specified by:
valueFetcher
in classMappedFieldType
-
indexedValueForSearch
public org.apache.lucene.util.BytesRef indexedValueForSearch(java.lang.Object value)Description copied from class:TermBasedFieldType
Returns the indexed value used to construct search "values". This method is used for the default implementations of most query factory methods such asTermBasedFieldType.termQuery(java.lang.Object, org.elasticsearch.index.query.QueryShardContext)
.- Overrides:
indexedValueForSearch
in classTermBasedFieldType
-
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 classMappedFieldType
-
fielddataBuilder
public IndexFieldData.Builder fielddataBuilder(java.lang.String fullyQualifiedIndexName, java.util.function.Supplier<SearchLookup> searchLookup)Description copied from class:MappedFieldType
Return a fielddata builder for this field- Overrides:
fielddataBuilder
in classMappedFieldType
- Parameters:
fullyQualifiedIndexName
- the name of the index this field-data is build forsearchLookup
- aSearchLookup
supplier to allow for accessing other fields values in the context of runtime fields
-
docValueFormat
Description copied from class:MappedFieldType
Return aDocValueFormat
that can be used to display and parse values as returned by the fielddata API. The default implementation returns aDocValueFormat.RAW
.- Overrides:
docValueFormat
in classMappedFieldType
-
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 asSimpleMappedFieldType.rangeQuery(Object, Object, boolean, boolean, ShapeRelation, ZoneId, DateMathParser, QueryShardContext)
but without the trouble of relations or date-specific options.- Overrides:
rangeQuery
in classSimpleMappedFieldType
-