Package org.opensearch.index.mapper

Class ParseContext.InternalParseContext

java.lang.Object

org.opensearch.index.mapper.ParseContext

org.opensearch.index.mapper.ParseContext.InternalParseContext

All Implemented Interfaces:

Iterable<ParseContext.Document>

Enclosing class:

ParseContext

public static class ParseContext.InternalParseContext
extends ParseContext

An internal parse context

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.index.mapper.ParseContext

ParseContext.Document, ParseContext.InternalParseContext

Constructor Summary

Constructors

Constructor	Description
InternalParseContext(IndexSettings indexSettings, DocumentMapperParser docMapperParser, DocumentMapper docMapper, SourceToParse source, org.opensearch.core.xcontent.XContentParser parser)

Method Summary

Modifier and Type	Method	Description
protected void	addDoc(ParseContext.Document doc)
void	addDynamicMapper(Mapper mapper)	Add a new mapper dynamically created while parsing.
void	addIgnoredField(String field)	Add the given field to the set of ignored fields.
void	checkFieldArrayDepthLimit()
void	checkFieldDepthLimit()
void	decrementFieldArrayDepth()
void	decrementFieldCurrentDepth()
ParseContext.Document	doc()
DocumentMapper	docMapper()
DocumentMapperParser	docMapperParser()
List<Mapper>	getDynamicMappers()	Get dynamic mappers created while parsing.
Collection<String>	getIgnoredFields()	Return the collection of fields that have been ignored so far.
void	incrementFieldArrayDepth()
void	incrementFieldCurrentDepth()
IndexSettings	indexSettings()
Iterator<ParseContext.Document>	iterator()
MapperService	mapperService()
Iterable<ParseContext.Document>	nonRootDocuments()	Returns an Iterable over all non-root documents.
org.opensearch.core.xcontent.XContentParser	parser()
ContentPath	path()
RootObjectMapper	root()
ParseContext.Document	rootDoc()
SeqNoFieldMapper.SequenceIDFields	seqID()
void	seqID(SeqNoFieldMapper.SequenceIDFields seqID)
SourceToParse	sourceToParse()
org.apache.lucene.document.Field	version()
void	version(org.apache.lucene.document.Field version)

Methods inherited from class org.opensearch.index.mapper.ParseContext

createCopyToContext, createExternalValueContext, createMultiFieldContext, createNestedContext, externalValue, externalValueSet, isWithinCopyTo, isWithinMultiFields, overridePath, parseExternalValue, switchDoc

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

InternalParseContext

public InternalParseContext(IndexSettings indexSettings,
 DocumentMapperParser docMapperParser,
 DocumentMapper docMapper,
 SourceToParse source,
 org.opensearch.core.xcontent.XContentParser parser)

Method Details

docMapperParser

public DocumentMapperParser docMapperParser()

Specified by:

docMapperParser in class ParseContext

indexSettings

public IndexSettings indexSettings()

Specified by:

indexSettings in class ParseContext

sourceToParse

public SourceToParse sourceToParse()

Specified by:

sourceToParse in class ParseContext

path

public ContentPath path()

Specified by:

path in class ParseContext

parser

public org.opensearch.core.xcontent.XContentParser parser()

Specified by:

parser in class ParseContext

rootDoc

public ParseContext.Document rootDoc()

Specified by:

rootDoc in class ParseContext

doc

public ParseContext.Document doc()

Specified by:

doc in class ParseContext

addDoc

protected void addDoc(ParseContext.Document doc)

Specified by:

addDoc in class ParseContext

root

public RootObjectMapper root()

Specified by:

root in class ParseContext

docMapper

public DocumentMapper docMapper()

Specified by:

docMapper in class ParseContext

mapperService

public MapperService mapperService()

Specified by:

mapperService in class ParseContext

version

public org.apache.lucene.document.Field version()

Specified by:

version in class ParseContext

version

public void version(org.apache.lucene.document.Field version)

Specified by:

version in class ParseContext

seqID

public SeqNoFieldMapper.SequenceIDFields seqID()

Specified by:

seqID in class ParseContext

seqID

public void seqID(SeqNoFieldMapper.SequenceIDFields seqID)

Specified by:

seqID in class ParseContext

addDynamicMapper

public void addDynamicMapper(Mapper mapper)

Description copied from class: ParseContext

Add a new mapper dynamically created while parsing.

Specified by:

addDynamicMapper in class ParseContext

getDynamicMappers

public List<Mapper> getDynamicMappers()

Description copied from class: ParseContext

Get dynamic mappers created while parsing.

Specified by:

getDynamicMappers in class ParseContext

nonRootDocuments

public Iterable<ParseContext.Document> nonRootDocuments()

Description copied from class: ParseContext

Returns an Iterable over all non-root documents. If there are no non-root documents the iterable will return an empty iterator.

Specified by:

nonRootDocuments in class ParseContext

iterator

public Iterator<ParseContext.Document> iterator()

addIgnoredField

public void addIgnoredField(String field)

Description copied from class: ParseContext

Add the given field to the set of ignored fields.

Specified by:

addIgnoredField in class ParseContext

getIgnoredFields

public Collection<String> getIgnoredFields()

Description copied from class: ParseContext

Return the collection of fields that have been ignored so far.

Specified by:

getIgnoredFields in class ParseContext

incrementFieldCurrentDepth

public void incrementFieldCurrentDepth()

Specified by:

incrementFieldCurrentDepth in class ParseContext

decrementFieldCurrentDepth

public void decrementFieldCurrentDepth()

Specified by:

decrementFieldCurrentDepth in class ParseContext

checkFieldDepthLimit

public void checkFieldDepthLimit()

Specified by:

checkFieldDepthLimit in class ParseContext

incrementFieldArrayDepth

public void incrementFieldArrayDepth()

Specified by:

incrementFieldArrayDepth in class ParseContext

decrementFieldArrayDepth

public void decrementFieldArrayDepth()

Specified by:

decrementFieldArrayDepth in class ParseContext

checkFieldArrayDepthLimit

public void checkFieldArrayDepthLimit()

Specified by:

checkFieldArrayDepthLimit in class ParseContext