Package org.opensearch.index.mapper
package org.opensearch.index.mapper
Package containing OpenSearch Field Mappers
-
ClassDescriptionAbstractGeometryFieldMapper<Parsed,
Processed> Base field mapper class for all spatial field typesAbstractGeometryFieldMapper.AbstractGeometryFieldType<Parsed,Processed> Base field type for all geometry fieldsAbstractGeometryFieldMapper.Builder<T extends AbstractGeometryFieldMapper.Builder<T,FT>, FT extends AbstractGeometryFieldMapper.AbstractGeometryFieldType> Builder for the base geometry field mapperDefault parameters for the base geometry field mapperAbstractGeometryFieldMapper.Indexer<Parsed,Processed> Interface representing an preprocessor in geometry indexing pipelineString parameter names for the base geometry field mapperInterface representing parser in geometry indexing pipeline.Base type parser for geometry field mappersAbstractPointGeometryFieldMapper<Parsed,Processed> Base class for for spatial fields that only support indexing pointsAbstractPointGeometryFieldMapper.AbstractPointGeometryFieldType<Parsed,Processed> Base field type for the base point geometry field mapperAbstractPointGeometryFieldMapper.Builder<T extends AbstractPointGeometryFieldMapper.Builder<T,FT>, FT extends AbstractPointGeometryFieldMapper.AbstractPointGeometryFieldType> Base builder for the base point geometry field mapperCommon parameter names for the base point geometry field mapperrepresents a Point that has been parsed byAbstractPointGeometryFieldMapper.PointParser
AbstractPointGeometryFieldMapper.PointParser<P extends AbstractPointGeometryFieldMapper.ParsedPoint>A parser implementation that can parse the various point formatsBase type parser for the base point geometry field mapperAbstractShapeGeometryFieldMapper<Parsed,Processed> Base class forGeoShapeFieldMapper
andLegacyGeoShapeFieldMapper
AbstractShapeGeometryFieldMapper.AbstractShapeGeometryFieldType<Parsed,Processed> Base field type for the base shape geometry field mapperAbstractShapeGeometryFieldMapper.Builder<T extends AbstractShapeGeometryFieldMapper.Builder<T,FT>, FT extends AbstractShapeGeometryFieldMapper.AbstractShapeGeometryFieldType> Base builder for the base shape geometry field mapperParameter defaults for the base shape geometry field mapperCommon parameters for the base shape geometry field mapperBase type parser for the base shape geometry field mapperAn implementation ofValueFetcher
that knows how to extract values from the document source.A mapper for binary fieldsBinary field typeBuilder for the binary field mapperCustom binary doc values field for the binary field mapperA field mapper for boolean fields.Field type for boolean field mapperBuilder for this field mapperDefault parameters for the boolean field mapperValues that can be used for this field mapperMapper for completion field.Builder forCompletionFieldMapper
Field type for Completion Field MapperDefault parametersParameter fieldsAMappedFieldType
that has the same value for all documents.JSON Path for a document / fieldBase class for constructing a custom docvalues type used for binary, geo, and range fieldsField mapper for a datastream fieldBuilder for the field mapperField type for data stream field mapperDefault parametersAFieldMapper
for dates.Builder for the date field mapperField type for date field mapperResolution of the date timeMapper for the doc_count field.Field type for DocCount Field MapperThe OpenSearch DocumentMapperBuilder for the Document Field MapperDeprecated.types are being removedParser for a document mapperValue fetcher that loads from doc values.Leaf interfaceA field mapper that supports lookup of dynamic sub-keys.A template that is dynamic based on field typesMatch type of the templateThe type of a field as detected while parsing a json document.A mapper for field aliases.The bulider for the field alias field mapperParameter namesThe type parserThe base OpenSearch Field MapperFieldMapper.Builder<T extends FieldMapper.Builder<T>>Base builder for all field mappersRepresents a list of fields with optional boost factor where the current field should be copied toBuilder for the copyTo fieldMulti field implementation used across field mappersConcrete builder for field mappersA mapper that indexes the field names of a document under_field_names
.Parameter defaultsField type for FieldNames field mapperField Mapper for geo_point types.Concrete builder for geo_point typesConcrete field type for geo_pointThe indexer for geo_pointA geo point parsed from geojsonConcrete parser for geo_point typesFieldMapper for indexingLatLonShape
s.Concrete builder for geo_shape typesConcrete field type for geo_shape fieldsThe type parserUtility class that converts geometries into Lucene-compatible form for indexing in a geo_shape field.Utility class that parses geo shapesImplemented byMappedFieldType
that support GeoShape queries.A mapper for the _id field.Default parametersA field mapper that records fields that have been ignored because they were malformed.Default parametersField type for Ignored fieldsIndex specific field mapperAFieldMapper
for ip addresses.BuilderField type for IP fieldsField type for IP Scripted doc valuesA field mapper for keywords.The builder for the field mapperDefault parametersThe keyword field for the field mapperField type for keyword fieldsDeprecated.The builder for the deprecated prefix tree implementationDeprecated.Deprecated defaults for legacy prefix treesDeprecated parameter names for Prefix treesDeprecated prefix tree typesField type for GeoShape fieldsDeprecated.will be removed in the next versionThis defines the core properties and functions to operate on a field.An enum used to describe the relation between the range of terms in a shard when compared with a query rangeThe foundation OpenSearch mapperMapper.Builder<T extends Mapper.Builder>Base mapper builderThe builder context used in field mappingsType parser for the mapperParser context for the type parserException thrown for any mapping errorsException thrown if there are any errors parsing mappingsThe core field mapping serviceThe reason why a mapping is being merged.Wrapper around everything that defines a mapping, without references to utility classes like MapperService, ...Looks up a mapping for a fieldA mapper for a builtin field containing metadata about a document.Base builder for internal metadata fieldsType parser that is configurableA type parser for an unconfigurable metadata field.Type parser for the field mapperReplacement for TypesFieldMapper used in nested fieldsDefault parameters for the field mapperfield type for the NestPath fieldAFieldMapper
for numeric types: byte, short, int, long, float and double.Builder for the number field mappersField type for numeric fieldsType of numberField mapper for object field typesObjectMapper.Builder<T extends ObjectMapper.Builder>Builder for object field mapperParameter defaultsDynamic field mapping specificationNested objectsType parser for object field mapperDefines how a particular field should be indexed and searched ConfigurationParametrizedFieldMapper.Parameter
s for the mapper are defined on aParametrizedFieldMapper.Builder
subclass, and returned by itsParametrizedFieldMapper.Builder.getParameters()
method.A Builder for a ParametrizedFieldMapperA configurable parameter for a field mapperSerializes a parameterCheck on whether or not a parameter should be serializedTypeParser implementation that automatically handles parsingHolds the context at parse timeFork ofDocument
with additional functionality.An internal parse contextThe result of parsing a document.AFieldMapper
for indexing numeric and date ranges, and creating queriesBuilder for range fieldsDefault parameters for range fieldsClass defining a rangeField type for range fieldsEnum defining the type of rangeType of lengthThe root object mapper for a documentBuilder for the root objectDefault parameters for root objectType parser for the root objectInternal field mapper for _routing fieldsBuilder for routing fieldsDefault parameters for routing fieldsMapper for the_seq_no
field.A sequence ID, which is made up of a sequence number (both the searchable and doc_value version of the field) and the primary term.MappedFieldType
base impl for field types that are neither dates nor ranges.Internal field mapper for storing source (and recovery source)Builder for source fieldsDefault parameters for source fieldsStores the document sourceOrigin of the sourceAn implementation ofValueFetcher
that knows how to extract values from the document source.Exception thrown when mapping is set to `STRICT`Base class forMappedFieldType
implementations that use the same representation for internal index terms as the external representation so that partial matching queries such as prefix, wildcard and fuzzy queries can be implemented.BaseMappedFieldType
implementation for a field that is indexed with the inverted index.AFieldMapper
for full-text fields.Builder for text fieldsDefault paramters for text fieldsField type for text fieldsUtility functions for text mapper parametersAnalyzers for textEncapsulates information about how to perform text searches over a fieldWhat sort of term vectors are availableFoundation type parsersA documents OpenSearch idA helper class for fetching field values during theFetchFieldsPhase
.Mapper for the _version field.