java.lang.Object

org.opensearch.index.mapper.DocumentMapper

All Implemented Interfaces:: org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

public class DocumentMapper
extends java.lang.Object
implements org.opensearch.common.xcontent.ToXContentFragment

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class DocumentMapper.Builder

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent
org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params
Field Summary

Fields inherited from interface org.opensearch.common.xcontent.ToXContent
EMPTY_PARAMS
Constructor Summary

Constructors

Constructor Description

DocumentMapper(MapperService mapperService, Mapping mapping)

Method Summary

Modifier and Type	Method	Description
`ParsedDocument`	`createDeleteTombstoneDoc(java.lang.String index, java.lang.String type, java.lang.String id)`
`ParsedDocument`	`createNoopTombstoneDoc(java.lang.String index, java.lang.String reason)`
`org.opensearch.index.mapper.FieldTypeLookup`	`fieldTypes()`
`ObjectMapper`	`findNestedObjectMapper(int nestedDocId, SearchContext sc, org.apache.lucene.index.LeafReaderContext context)`	Returns the best nested `ObjectMapper` instances that is in the scope of the specified nested docId.
`boolean`	`hasNestedObjects()`
`IdFieldMapper`	`idFieldMapper()`
`IndexFieldMapper`	`IndexFieldMapper()`
`IndexFieldMapper`	`indexMapper()`
`MappingLookup`	`mappers()`
`Mapping`	`mapping()`
`CompressedXContent`	`mappingSource()`
`DocumentMapper`	`merge(Mapping mapping, MapperService.MergeReason reason)`
`java.util.Map<java.lang.String,java.lang.Object>`	`meta()`
`<T extends MetadataFieldMapper> T`	`metadataMapper(java.lang.Class<T> type)`
`java.util.Map<java.lang.String,ObjectMapper>`	`objectMappers()`
`ParsedDocument`	`parse(SourceToParse source)`
`RootObjectMapper`	`root()`
`RoutingFieldMapper`	`routingFieldMapper()`
`SourceFieldMapper`	`sourceMapper()`
`java.lang.String`	`toString()`
`org.opensearch.common.xcontent.XContentBuilder`	`toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)`
`java.lang.String`	`type()`
`TypeFieldMapper`	`typeMapper()`
`Text`	`typeText()`
`void`	`validate(IndexSettings settings, boolean checkLimits)`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Constructor Details
- DocumentMapper
  
  public DocumentMapper(MapperService mapperService, Mapping mapping)
Method Details
- mapping
  
  public Mapping mapping()
- type
  
  public java.lang.String type()
- typeText
  
  public Text typeText()
- meta
  
  public java.util.Map<java.lang.String,java.lang.Object> meta()
- mappingSource
  
  public CompressedXContent mappingSource()
- root
  
  public RootObjectMapper root()
- metadataMapper
  
  public <T extends MetadataFieldMapper> T metadataMapper(java.lang.Class<T> type)
- indexMapper
  
  public IndexFieldMapper indexMapper()
- typeMapper
  
  public TypeFieldMapper typeMapper()
- sourceMapper
  
  public SourceFieldMapper sourceMapper()
- idFieldMapper
  
  public IdFieldMapper idFieldMapper()
- routingFieldMapper
  
  public RoutingFieldMapper routingFieldMapper()
- IndexFieldMapper
  
  public IndexFieldMapper IndexFieldMapper()
- hasNestedObjects
  
  public boolean hasNestedObjects()
- mappers
  
  public MappingLookup mappers()
- fieldTypes
  
  public org.opensearch.index.mapper.FieldTypeLookup fieldTypes()
- objectMappers
  
  public java.util.Map<java.lang.String,ObjectMapper> objectMappers()
- parse
  
  public ParsedDocument parse(SourceToParse source) throws MapperParsingException
  
  Throws:
  
  MapperParsingException
- createDeleteTombstoneDoc
  
  public ParsedDocument createDeleteTombstoneDoc(java.lang.String index, java.lang.String type, java.lang.String id) throws MapperParsingException
  
  Throws:
  
  MapperParsingException
- createNoopTombstoneDoc
  
  public ParsedDocument createNoopTombstoneDoc(java.lang.String index, java.lang.String reason) throws MapperParsingException
  
  Throws:
  
  MapperParsingException
- findNestedObjectMapper
  
  public ObjectMapper findNestedObjectMapper(int nestedDocId, SearchContext sc, org.apache.lucene.index.LeafReaderContext context) throws java.io.IOException
  
  Returns the best nested ObjectMapper instances that is in the scope of the specified nested docId.
  
  Throws:
  
  java.io.IOException
- merge
  
  public DocumentMapper merge(Mapping mapping, MapperService.MergeReason reason)
- validate
  
  public void validate(IndexSettings settings, boolean checkLimits)
- toXContent
  
  public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
  
  Specified by:
  
  toXContent in interface org.opensearch.common.xcontent.ToXContent
  
  Throws:
  
  java.io.IOException
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object

Class DocumentMapper

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

Field Summary

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

Constructor Details

Method Details