java.lang.Object

org.elasticsearch.index.mapper.ParseContext

Direct Known Subclasses:: ParseContext.InternalParseContext

public abstract class ParseContext
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ParseContext.Document`	Fork of `Document` with additional functionality.
`static class`	`ParseContext.InternalParseContext`

Constructor Summary

Constructors

Constructor Description

ParseContext()

Method Summary

Modifier and Type	Method	Description
`protected abstract void`	`addDoc(ParseContext.Document doc)`
`abstract void`	`addDynamicMapper(Mapper update)`	Add a new mapper dynamically created while parsing.
`abstract void`	`addDynamicRuntimeField(RuntimeFieldType runtimeField)`	Add a new runtime field dynamically created while parsing.
`abstract void`	`addIgnoredField(java.lang.String field)`	Add the given `field` to the set of ignored fields.
`ParseContext`	`createCopyToContext()`	Return a new context that will be within a copy-to operation.
`ParseContext`	`createExternalValueContext(java.lang.Object externalValue)`	Return a new context that will have the external value set.
`ParseContext`	`createMultiFieldContext()`	Return a new context that will be within multi-fields.
`ParseContext`	`createNestedContext(java.lang.String fullPath)`	Return a new context that will be used within a nested document.
`abstract ParseContext.Document`	`doc()`
`abstract DocumentMapper`	`docMapper()`
`abstract java.util.List<ParseContext.Document>`	`docs()`
`java.lang.Object`	`externalValue()`
`boolean`	`externalValueSet()`
`abstract java.util.List<Mapper>`	`getDynamicMappers()`	Get dynamic mappers created while parsing.
`abstract java.util.List<RuntimeFieldType>`	`getDynamicRuntimeFields()`	Get dynamic runtime fields created while parsing.
`abstract DynamicRuntimeFieldsBuilder`	`getDynamicRuntimeFieldsBuilder()`	Retrieve the builder for dynamically created runtime fields
`abstract java.util.Collection<java.lang.String>`	`getIgnoredFields()`	Return the collection of fields that have been ignored so far.
`abstract ObjectMapper`	`getObjectMapper(java.lang.String name)`
`abstract IndexAnalyzers`	`indexAnalyzers()`
`abstract IndexSettings`	`indexSettings()`
`boolean`	`isWithinCopyTo()`
`boolean`	`isWithinMultiFields()`
`abstract java.lang.Iterable<ParseContext.Document>`	`nonRootDocuments()`	Returns an Iterable over all non-root documents.
`ParseContext`	`overridePath(ContentPath path)`	Return a new context that will have the provided path.
`<T> T`	`parseExternalValue(java.lang.Class<T> clazz)`	Try to parse an externalValue if any
`abstract org.elasticsearch.common.xcontent.XContentParser`	`parser()`
`abstract Mapper.TypeParser.ParserContext`	`parserContext(DateFormatter dateFormatter)`
`abstract ContentPath`	`path()`
`abstract RootObjectMapper`	`root()`
`abstract ParseContext.Document`	`rootDoc()`
`abstract SeqNoFieldMapper.SequenceIDFields`	`seqID()`
`abstract void`	`seqID(SeqNoFieldMapper.SequenceIDFields seqID)`
`abstract SourceToParse`	`sourceToParse()`
`ParseContext`	`switchDoc(ParseContext.Document document)`	Return a new context that has the provided document as the current document.
`abstract org.apache.lucene.document.Field`	`version()`
`abstract void`	`version(org.apache.lucene.document.Field version)`

Methods inherited from class java.lang.Object

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

Constructor Details
- ParseContext
  
  public ParseContext()
Method Details
- nonRootDocuments
  
  public abstract java.lang.Iterable<ParseContext.Document> nonRootDocuments()
  
  Returns an Iterable over all non-root documents. If there are no non-root documents the iterable will return an empty iterator.
- addIgnoredField
  
  public abstract void addIgnoredField(java.lang.String field)
  
  Add the given field to the set of ignored fields.
- getIgnoredFields
  
  public abstract java.util.Collection<java.lang.String> getIgnoredFields()
  
  Return the collection of fields that have been ignored so far.
- parserContext
  
  public abstract Mapper.TypeParser.ParserContext parserContext(DateFormatter dateFormatter)
- createCopyToContext
  
  public final ParseContext createCopyToContext()
  
  Return a new context that will be within a copy-to operation.
- isWithinCopyTo
  
  public boolean isWithinCopyTo()
- createMultiFieldContext
  
  public final ParseContext createMultiFieldContext()
  
  Return a new context that will be within multi-fields.
- createNestedContext
  
  public final ParseContext createNestedContext(java.lang.String fullPath)
  
  Return a new context that will be used within a nested document.
- switchDoc
  
  public final ParseContext switchDoc(ParseContext.Document document)
  
  Return a new context that has the provided document as the current document.
- overridePath
  
  public final ParseContext overridePath(ContentPath path)
  
  Return a new context that will have the provided path.
- isWithinMultiFields
  
  public boolean isWithinMultiFields()
- indexSettings
  
  public abstract IndexSettings indexSettings()
- sourceToParse
  
  public abstract SourceToParse sourceToParse()
- path
  
  public abstract ContentPath path()
- parser
  
  public abstract org.elasticsearch.common.xcontent.XContentParser parser()
- rootDoc
  
  public abstract ParseContext.Document rootDoc()
- docs
  
  public abstract java.util.List<ParseContext.Document> docs()
- doc
  
  public abstract ParseContext.Document doc()
- addDoc
  
  protected abstract void addDoc(ParseContext.Document doc)
- root
  
  public abstract RootObjectMapper root()
- docMapper
  
  public abstract DocumentMapper docMapper()
- indexAnalyzers
  
  public abstract IndexAnalyzers indexAnalyzers()
- version
  
  public abstract org.apache.lucene.document.Field version()
- version
  
  public abstract void version(org.apache.lucene.document.Field version)
- seqID
  
  public abstract SeqNoFieldMapper.SequenceIDFields seqID()
- seqID
  
  public abstract void seqID(SeqNoFieldMapper.SequenceIDFields seqID)
- createExternalValueContext
  
  public final ParseContext createExternalValueContext(java.lang.Object externalValue)
  
  Return a new context that will have the external value set.
- externalValueSet
  
  public boolean externalValueSet()
- externalValue
  
  public java.lang.Object externalValue()
- parseExternalValue
  
  public final <T> T parseExternalValue(java.lang.Class<T> clazz)
  
  Try to parse an externalValue if any
  
  Parameters:
  
  clazz - Expected class for external value
  
  Returns:
  
  null if no external value has been set or the value
- addDynamicMapper
  
  public abstract void addDynamicMapper(Mapper update)
  
  Add a new mapper dynamically created while parsing.
- getObjectMapper
  
  public abstract ObjectMapper getObjectMapper(java.lang.String name)
- getDynamicMappers
  
  public abstract java.util.List<Mapper> getDynamicMappers()
  
  Get dynamic mappers created while parsing.
- addDynamicRuntimeField
  
  public abstract void addDynamicRuntimeField(RuntimeFieldType runtimeField)
  
  Add a new runtime field dynamically created while parsing.
- getDynamicRuntimeFields
  
  public abstract java.util.List<RuntimeFieldType> getDynamicRuntimeFields()
  
  Get dynamic runtime fields created while parsing.
- getDynamicRuntimeFieldsBuilder
  
  public abstract DynamicRuntimeFieldsBuilder getDynamicRuntimeFieldsBuilder()
  
  Retrieve the builder for dynamically created runtime fields
  
  See Also:
  
  MapperPlugin.getDynamicRuntimeFieldsBuilder()

Class ParseContext

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Method Details