ObjectMapper (Elasticsearch: Core 2.3.5.1 API)

java.lang.Object
- org.elasticsearch.index.mapper.Mapper
- - org.elasticsearch.index.mapper.object.ObjectMapper

すべての実装されたインタフェース:

Cloneable, Iterable<Mapper>, ToXContent, AllFieldMapper.IncludeInAll

直系の既知のサブクラス:

RootObjectMapper
```
public class ObjectMapper
extends Mapper
implements AllFieldMapper.IncludeInAll, Cloneable
```

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`ObjectMapper.Builder<T extends ObjectMapper.Builder,Y extends ObjectMapper>`
`static class`	`ObjectMapper.Defaults`
`static class`	`ObjectMapper.Dynamic`
`static class`	`ObjectMapper.Nested`
`static class`	`ObjectMapper.TypeParser`

クラスから継承されたネストされたクラス/インタフェース org.elasticsearch.index.mapper.Mapper
Mapper.BuilderContext

インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

static String CONTENT_TYPE

static String NESTED_CONTENT_TYPE
- インタフェースから継承されたフィールド org.elasticsearch.common.xcontent.ToXContent
  EMPTY_PARAMS

フィールド
修飾子とタイプ	フィールドと説明
`static String`	`CONTENT_TYPE`
`static String`	`NESTED_CONTENT_TYPE`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected ObjectMapper`	`clone()`
`protected void`	`doMerge(ObjectMapper mergeWith, boolean updateAllTypes)`
`protected void`	`doXContent(XContentBuilder builder, ToXContent.Params params)`
`ObjectMapper.Dynamic`	`dynamic()`
`String`	`fullPath()`
`Mapper`	`getMapper(String field)`
`ObjectMapper`	`includeInAll(Boolean includeInAll)` If `includeInAll` is not null then return a copy of this mapper that will include values in the _all field according to `includeInAll`.
`ObjectMapper`	`includeInAllIfNotSet(Boolean includeInAll)` If `includeInAll` is not null and not set on this mapper yet, then return a copy of this mapper that will include values in the _all field according to `includeInAll`.
`boolean`	`isEnabled()`
`Iterator<Mapper>`	`iterator()`
`ObjectMapper`	`mappingUpdate(Mapper mapper)` Build a mapping update with the provided sub mapping update.
`ObjectMapper`	`merge(Mapper mergeWith, boolean updateAllTypes)` Return the merge of `mergeWith` into this.
`String`	`name()` Returns the canonical name which uniquely identifies the mapper against other mappers in a type.
`ObjectMapper.Nested`	`nested()`
`org.apache.lucene.search.Query`	`nestedTypeFilter()`
`String`	`nestedTypePathAsString()`
`ContentPath.Type`	`pathType()`
`protected void`	`putMapper(Mapper mapper)`
`XContentBuilder`	`toXContent(XContentBuilder builder, ToXContent.Params params)`
`void`	`toXContent(XContentBuilder builder, ToXContent.Params params, ToXContent custom)`
`ObjectMapper`	`unsetIncludeInAll()` If `includeInAll` was already set on this mapper then return a copy of this mapper that has `includeInAll` not set.
`ObjectMapper`	`updateFieldType(Map<String,MappedFieldType> fullNameToFieldType)` Update the field type of this mapper.

クラスから継承されたメソッド org.elasticsearch.index.mapper.Mapper
simpleName

クラスから継承されたメソッド java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェースから継承されたメソッド java.lang.Iterable
forEach, spliterator

- フィールドの詳細
  - CONTENT_TYPE
```
public static final String CONTENT_TYPE
```
    関連項目:
    
    定数フィールド値
  - NESTED_CONTENT_TYPE
```
public static final String NESTED_CONTENT_TYPE
```
    関連項目:
    
    定数フィールド値
- メソッドの詳細
  - clone
```
protected ObjectMapper clone()
```
    オーバーライド:
    
    clone クラス内 Object
  - mappingUpdate
```
public ObjectMapper mappingUpdate(Mapper mapper)
```
    Build a mapping update with the provided sub mapping update.
  - name
```
public String name()
```
    クラスからコピーされた説明: Mapper
    
    Returns the canonical name which uniquely identifies the mapper against other mappers in a type.
    
    定義:
    
    name クラス内 Mapper
  - isEnabled
```
public boolean isEnabled()
```
  - pathType
```
public ContentPath.Type pathType()
```
  - getMapper
```
public Mapper getMapper(String field)
```
  - includeInAll
```
public ObjectMapper includeInAll(Boolean includeInAll)
```
    インタフェースからコピーされた説明: AllFieldMapper.IncludeInAll
    
    If includeInAll is not null then return a copy of this mapper that will include values in the _all field according to includeInAll.
    
    定義:
    
    includeInAll インタフェース内 AllFieldMapper.IncludeInAll
  - includeInAllIfNotSet
```
public ObjectMapper includeInAllIfNotSet(Boolean includeInAll)
```
    インタフェースからコピーされた説明: AllFieldMapper.IncludeInAll
    
    If includeInAll is not null and not set on this mapper yet, then return a copy of this mapper that will include values in the _all field according to includeInAll.
    
    定義:
    
    includeInAllIfNotSet インタフェース内 AllFieldMapper.IncludeInAll
  - unsetIncludeInAll
```
public ObjectMapper unsetIncludeInAll()
```
    インタフェースからコピーされた説明: AllFieldMapper.IncludeInAll
    
    If includeInAll was already set on this mapper then return a copy of this mapper that has includeInAll not set.
    
    定義:
    
    unsetIncludeInAll インタフェース内 AllFieldMapper.IncludeInAll
  - nested
```
public ObjectMapper.Nested nested()
```
  - nestedTypeFilter
```
public org.apache.lucene.search.Query nestedTypeFilter()
```
  - putMapper
```
protected void putMapper(Mapper mapper)
```
  - iterator
```
public Iterator<Mapper> iterator()
```
    定義:
    
    iterator インタフェース内 Iterable<Mapper>
  - fullPath
```
public String fullPath()
```
  - nestedTypePathAsString
```
public String nestedTypePathAsString()
```
  - dynamic
```
public final ObjectMapper.Dynamic dynamic()
```
  - merge
```
public ObjectMapper merge(Mapper mergeWith,
                          boolean updateAllTypes)
```
    クラスからコピーされた説明: Mapper
    
    Return the merge of mergeWith into this. Both this and mergeWith will be left unmodified.
    
    定義:
    
    merge クラス内 Mapper
  - doMerge
```
protected void doMerge(ObjectMapper mergeWith,
                       boolean updateAllTypes)
```
  - updateFieldType
```
public ObjectMapper updateFieldType(Map<String,MappedFieldType> fullNameToFieldType)
```
    クラスからコピーされた説明: Mapper
    
    Update the field type of this mapper. This is necessary because some mapping updates can modify mappings across several types. This method must return a copy of the mapper so that the current mapper is not modified.
    
    定義:
    
    updateFieldType クラス内 Mapper
  - toXContent
```
public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException
```
    定義:
    
    toXContent インタフェース内 ToXContent
    
    例外:
    
    IOException
  - toXContent
```
public void toXContent(XContentBuilder builder,
                       ToXContent.Params params,
                       ToXContent custom)
                throws IOException
```
    例外:
    
    IOException
  - doXContent
```
protected void doXContent(XContentBuilder builder,
                          ToXContent.Params params)
                   throws IOException
```
    例外:
    
    IOException

クラス ObjectMapper

ネストされたクラスのサマリー

クラスから継承されたネストされたクラス/インタフェース org.elasticsearch.index.mapper.Mapper

インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.xcontent.ToXContent

フィールドのサマリー

インタフェースから継承されたフィールド org.elasticsearch.common.xcontent.ToXContent

メソッドのサマリー

クラスから継承されたメソッド org.elasticsearch.index.mapper.Mapper

クラスから継承されたメソッド java.lang.Object

インタフェースから継承されたメソッド java.lang.Iterable

フィールドの詳細

CONTENT_TYPE

NESTED_CONTENT_TYPE

メソッドの詳細

clone

mappingUpdate

name

isEnabled

pathType

getMapper

includeInAll

includeInAllIfNotSet

unsetIncludeInAll

nested

nestedTypeFilter

putMapper

iterator

fullPath

nestedTypePathAsString

dynamic

merge

doMerge

updateFieldType

toXContent

toXContent

doXContent