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 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.PointParserAbstractPointGeometryFieldMapper.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 forGeoShapeFieldMapperandLegacyGeoShapeFieldMapperAbstractShapeGeometryFieldMapper.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 ofValueFetcherthat 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 forCompletionFieldMapperField type for Completion Field MapperDefault parametersParameter fieldsBase class for multi field data cube fieldsBase class for composite field typesSupported composite field typesAMappedFieldTypethat has the same value for all documents.Index specific field mapperBuilder for the binary field mapperField type for Index field mapperAMapper.TypeParserfor the constant keyword field.JSON Path for a document / fieldBase class for constructing a custom docvalues type.Field mapper for a datastream fieldBuilder for the field mapperField type for data stream field mapperDefault parametersAFieldMapperfor dates.Builder for the date field mapperField type for date field mapperResolution of the date timeAccepts definition of DerivedField from search request in both forms: map parsed from SearchRequest andDerivedFielddefined using client.DerivedField representation: expects a name, type and script.A field mapper for derived fieldsBuilder for this field mapperDerivedFieldResolver is used as a lookup to resolve derived fields from their name.Used to create DerivedFieldResolver.Contains logic to get the FieldMapper for a given type of derived field.MappedFieldType for Derived Fields Contains logic to execute different type of queries on a derived field of given type.The value fetcher contains logic to execute script and fetch the value in form of list of object.Mapper 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 mapperThis class performs type inference by analyzing the _source documents.Implementations of this interface should define the conversion logic from a sortable long value to a double value, taking into account any necessary scaling, normalization, or other transformations required by the specific field type.A field mapper for flat_objects.The builder for the flat_object field mapper using default parametersIn flat_object field mapper, field type is similar to keyword field type Cannot be tokenized, can OmitNorms, and can setIndexOption.FlatObjectFieldType is the parent field type.flat_object fields type contains its own fieldType, one valueFieldType and one valueAndPathFieldTypeCreates a new TypeParser for flatObjectFieldMapper that does not use ParameterizedFieldMapperField 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 indexingLatLonShapes.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 byMappedFieldTypethat 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 mapperAFieldMapperfor 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 parserAn interface that defines properties for MapperBuilder implementations.Exception 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 specialized type of TextFieldMapper which disables the positions and norms to save on storage and executes phrase queries, which requires positional data, in a slightly less efficient manner using theSourceFieldMatchQuery.Builder class for constructing the MatchOnlyTextFieldMapper.The specific field type for MatchOnlyTextFieldMapperA 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 fieldUsed when the derived field feature is disabledAFieldMapperfor numeric types: byte, short, int, long, float and double.Builder for the number field mappersField type for numeric fieldsType of numberInterface for encoding a point valueRepresents a derived field in OpenSearch, which behaves similarly to an Object field type within the context of derived fields.Field 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 searchedA 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 ofDocumentwith additional functionality.An internal parse contextThe result of parsing a document.AFieldMapperfor 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_nofield.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.MappedFieldTypebase 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 ofValueFetcherthat knows how to extract values from the document source.A field mapper for star tree fieldsBuilder for the star tree field mapperStar tree mapped field type containing dimensions, metrics, star tree specsConcrete parse for star tree typeException thrown when mapping is set to `STRICT`Base class forMappedFieldTypeimplementations 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.BaseMappedFieldTypeimplementation for a field that is indexed with the inverted index.AFieldMapperfor full-text fields.Builder for text fieldsDefault paramters for text fieldsFrequency filter for field dataField mapper for phrase fieldsPrefix configurationField mapper for prefix 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.Mapper for the "wildcard" field type, which supports (relatively) efficient matching by wildcard, prefix, and regexp queries.The builder for the field mapper.Implements the various query types over wildcard fields.