Package org.elasticsearch.index.mapper

Class ParseContext

java.lang.Object
org.elasticsearch.index.mapper.ParseContext
Direct Known Subclasses:
ParseContext.InternalParseContext
public abstract class ParseContext
extends java.lang.Object

  • 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()

    • mappingLookup

      public abstract MappingLookup mappingLookup()

    • getMetadataMapper

      public abstract MetadataFieldMapper getMetadataMapper​(java.lang.String mapperName)

    • 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​(RuntimeField runtimeField)
      Add a new runtime field dynamically created while parsing.

    • getDynamicRuntimeFields

      public abstract java.util.List<RuntimeField> getDynamicRuntimeFields()
      Get dynamic runtime fields created while parsing.

    • findDynamicTemplate

      public final DynamicTemplate findDynamicTemplate​(java.lang.String fieldName, DynamicTemplate.XContentFieldType matchType)
      Find a dynamic mapping template for the given field and its matching type
      Parameters:
      fieldName - the name of the field
      matchType - the expecting matchType of the field
      Returns:
      the matching template; otherwise returns null
      Throws:
      MapperParsingException - if the given field has a dynamic template name specified, but no template matches that name.