java.lang.Object
org.elasticsearch.index.mapper.Mapper
org.elasticsearch.index.mapper.FieldMapper
org.elasticsearch.index.mapper.BooleanFieldMapper
- All Implemented Interfaces:
Iterable<Mapper>,ToXContent,ToXContentFragment
A field mapper for boolean fields.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classstatic final classstatic classNested classes/interfaces inherited from class org.elasticsearch.index.mapper.FieldMapper
FieldMapper.BuilderParams, FieldMapper.Conflicts, FieldMapper.CopyTo, FieldMapper.DimensionBuilder, FieldMapper.MergeValidator<T>, FieldMapper.MultiFields, FieldMapper.Parameter<T>, FieldMapper.Serializer<T>, FieldMapper.SerializerCheck<T>, FieldMapper.SyntheticSourceMode, FieldMapper.SyntheticSourceSupport, FieldMapper.TypeParserNested classes/interfaces inherited from class org.elasticsearch.index.mapper.Mapper
Mapper.SourceKeepModeNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params -
Field Summary
FieldsFields inherited from class org.elasticsearch.index.mapper.FieldMapper
builderParams, COERCE_SETTING, deprecationLogger, IGNORE_MALFORMED_SETTING, mappedFieldTypeFields inherited from class org.elasticsearch.index.mapper.Mapper
SYNTHETIC_SOURCE_KEEP_INDEX_SETTING, SYNTHETIC_SOURCE_KEEP_PARAMFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedBooleanFieldMapper(String simpleName, MappedFieldType mappedFieldType, FieldMapper.BuilderParams builderParams, boolean storeMalformedFields, BooleanFieldMapper.Builder builder, String offsetsFieldName) -
Method Summary
Modifier and TypeMethodDescriptionprotected StringvoiddoValidate(MappingLookup lookup) Returns aFieldMapper.Builderto be used for merging and serialization Implement as follows:return new MyBuilder(simpleName()).init(this);booleanWill this field ignore malformed values for this field and accept the document (true) or will it reject documents with malformed values for this field (false).protected voidindexScriptValues(SearchLookup searchLookup, org.apache.lucene.index.LeafReaderContext readerContext, int doc, DocumentParserContext documentParserContext) Run the script associated with the field and index the values that it emits This method should only be called ifFieldMapper.hasScript()has returnedtrueprotected voidparseCreateField(DocumentParserContext context) Parse the field value and populate the fields onDocumentParserContext.doc().protected FieldMapper.SyntheticSourceSupportReturns implementation of synthetic source support for the mapper.Methods inherited from class org.elasticsearch.index.mapper.FieldMapper
checkIncomingMergeType, copyTo, createTypeParserWithLegacySupport, doParseMultiFields, doXContentBody, executeScript, fullPath, getTotalFieldsCount, hasScript, iterator, merge, multiFields, multiFieldsIterator, notFromDynamicTemplates, notInMultiFields, parse, parsesArrayValue, sourceKeepMode, sourcePathUsedBy, supportsParsingObject, syntheticFieldLoader, syntheticVectorsLoader, throwIndexingWithScriptParam, toXContent, typeName, validateMethods inherited from class org.elasticsearch.index.mapper.Mapper
freezeAndDeduplicateFieldType, internFieldName, leafName, supportStoringArrayOffsets, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, spliteratorMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Field Details
-
CONTENT_TYPE
- See Also:
-
PARSER
-
-
Constructor Details
-
BooleanFieldMapper
protected BooleanFieldMapper(String simpleName, MappedFieldType mappedFieldType, FieldMapper.BuilderParams builderParams, boolean storeMalformedFields, BooleanFieldMapper.Builder builder, String offsetsFieldName)
-
-
Method Details
-
indexAnalyzers
- Overrides:
indexAnalyzersin classFieldMapper
-
fieldType
- Overrides:
fieldTypein classFieldMapper
-
getOffsetFieldName
- Overrides:
getOffsetFieldNamein classMapper- Returns:
- the offset field name used to store offsets iff
Mapper.supportStoringArrayOffsets()returnstrue.
-
parseCreateField
Description copied from class:FieldMapperParse the field value and populate the fields onDocumentParserContext.doc(). Implementations of this method should ensure that on failing to parse parser.currentToken() must be the current failing token- Specified by:
parseCreateFieldin classFieldMapper- Throws:
IOException
-
indexScriptValues
protected void indexScriptValues(SearchLookup searchLookup, org.apache.lucene.index.LeafReaderContext readerContext, int doc, DocumentParserContext documentParserContext) Description copied from class:FieldMapperRun the script associated with the field and index the values that it emits This method should only be called ifFieldMapper.hasScript()has returnedtrue- Overrides:
indexScriptValuesin classFieldMapper- Parameters:
searchLookup- a SearchLookup to be passed the scriptreaderContext- a LeafReaderContext exposing values from an incoming documentdoc- the id of the document to execute the script againstdocumentParserContext- the ParseContext over the incoming document
-
getMergeBuilder
Description copied from class:FieldMapperReturns aFieldMapper.Builderto be used for merging and serialization Implement as follows:return new MyBuilder(simpleName()).init(this);- Specified by:
getMergeBuilderin classFieldMapper
-
doValidate
- Overrides:
doValidatein classFieldMapper
-
ignoreMalformed
public boolean ignoreMalformed()Description copied from class:FieldMapperWill this field ignore malformed values for this field and accept the document (true) or will it reject documents with malformed values for this field (false). Some fields don't have a concept of "malformed" and will returnfalsehere.- Overrides:
ignoreMalformedin classFieldMapper
-
contentType
- Specified by:
contentTypein classFieldMapper
-
syntheticSourceSupport
Description copied from class:FieldMapperReturns implementation of synthetic source support for the mapper.
By default (meaningFieldMapper.SyntheticSourceSupport.Fallback), an exact full copy of parsed field value is stored separately and used for synthetic source.Field mappers must override this method if they provide a more efficient field-specific implementation of synthetic source.
- Overrides:
syntheticSourceSupportin classFieldMapper- Returns:
FieldMapper.SyntheticSourceMode
-