RoutingFieldMapper

java.lang.Object
- org.elasticsearch.index.mapper.core.AbstractFieldMapper<String>
- - org.elasticsearch.index.mapper.internal.RoutingFieldMapper

All Implemented Interfaces:: ToXContent, FieldMapper<String>, InternalMapper, Mapper, RootMapper

public class RoutingFieldMapper
extends AbstractFieldMapper<String>
implements InternalMapper, RootMapper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
`static class`	`RoutingFieldMapper.Builder`
`static class`	`RoutingFieldMapper.Defaults`
`static class`	`RoutingFieldMapper.TypeParser`

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper
AbstractFieldMapper.CopyTo, AbstractFieldMapper.MultiFields

Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.Mapper
Mapper.BuilderContext

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

Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.FieldMapper
FieldMapper.Loading, FieldMapper.Names

Field Summary

Fields

Modifier and Type	Field and Description
`static String`	`CONTENT_TYPE`
`static String`	`NAME`

Fields inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper
boost, copyTo, customFieldDataSettings, docValues, docValuesFormat, fieldDataType, fieldType, indexAnalyzer, multiFields, names, normsLoading, postingsFormat, searchAnalyzer, similarity

Fields inherited from interface org.elasticsearch.index.mapper.Mapper
EMPTY_ARRAY

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS

Fields inherited from interface org.elasticsearch.index.mapper.FieldMapper
DOC_VALUES_FORMAT

Constructor Summary

Constructors

Modifier	Constructor and Description
	`RoutingFieldMapper()`
`protected`	`RoutingFieldMapper(org.apache.lucene.document.FieldType fieldType, boolean required, String path, PostingsFormatProvider postingsProvider, DocValuesFormatProvider docValuesProvider, Settings fieldDataSettings, Settings indexSettings)`

Method Summary

All Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`protected String`	`contentType()`
`FieldDataType`	`defaultFieldDataType()`
`org.apache.lucene.document.FieldType`	`defaultFieldType()`
`boolean`	`hasDocValues()`
`boolean`	`includeInObject()` Should the mapper be included in the root `ObjectMapper`.
`void`	`markAsRequired()`
`void`	`merge(Mapper mergeWith, MergeContext mergeContext)`
`void`	`parse(ParseContext context)`
`protected void`	`parseCreateField(ParseContext context, List<org.apache.lucene.document.Field> fields)` Parse the field value and populate `fields`.
`String`	`path()`
`void`	`postParse(ParseContext context)` Called after `Mapper.parse(ParseContext)` on the `RootObjectMapper`.
`void`	`preParse(ParseContext context)` Called before `Mapper.parse(ParseContext)` on the `RootObjectMapper`.
`boolean`	`required()`
`XContentBuilder`	`toXContent(XContentBuilder builder, ToXContent.Params params)`
`String`	`value(org.apache.lucene.document.Document document)`
`String`	`value(Object value)` Returns the actual value of the field.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.index.mapper.Mapper
close, name, traverse, traverse

Field Detail
- NAME
```
public static final String NAME
```
  See Also:
  
  Constant Field Values
- CONTENT_TYPE
```
public static final String CONTENT_TYPE
```
  See Also:
  
  Constant Field Values

Constructor Detail

RoutingFieldMapper
```
public RoutingFieldMapper()
```

RoutingFieldMapper

protected RoutingFieldMapper(org.apache.lucene.document.FieldType fieldType,
                             boolean required,
                             String path,
                             PostingsFormatProvider postingsProvider,
                             DocValuesFormatProvider docValuesProvider,
                             @Nullable
                             Settings fieldDataSettings,
                             Settings indexSettings)

Method Detail
- defaultFieldType
```
public org.apache.lucene.document.FieldType defaultFieldType()
```
- defaultFieldDataType
```
public FieldDataType defaultFieldDataType()
```
- hasDocValues
```
public boolean hasDocValues()
```
- markAsRequired
```
public void markAsRequired()
```
- required
```
public boolean required()
```
- path
```
public String path()
```
- value
```
public String value(org.apache.lucene.document.Document document)
```
- value
```
public String value(Object value)
```
  Description copied from interface: FieldMapper
  
  Returns the actual value of the field.
- preParse
```
public void preParse(ParseContext context)
              throws IOException
```
  Description copied from interface: RootMapper
  
  Called before Mapper.parse(ParseContext) on the RootObjectMapper.
  
  Specified by:
  
  preParse in interface RootMapper
  
  Throws:
  
  IOException
- postParse
```
public void postParse(ParseContext context)
               throws IOException
```
  Description copied from interface: RootMapper
  
  Called after Mapper.parse(ParseContext) on the RootObjectMapper.
  
  Specified by:
  
  postParse in interface RootMapper
  
  Throws:
  
  IOException
- parse
```
public void parse(ParseContext context)
           throws IOException
```
  Specified by:
  
  parse in interface Mapper
  
  Overrides:
  
  parse in class AbstractFieldMapper<String>
  
  Throws:
  
  IOException
- includeInObject
```
public boolean includeInObject()
```
  Description copied from interface: RootMapper
  
  Should the mapper be included in the root ObjectMapper. If this method returns true, then Mapper.parse(ParseContext) will be called if the context has a property that matches the name of this RootMapper. Otherwise Mapper.parse(ParseContext) will not be called.
- parseCreateField
```
protected void parseCreateField(ParseContext context,
                                List<org.apache.lucene.document.Field> fields)
                         throws IOException
```
  Description copied from class: AbstractFieldMapper
  
  Parse the field value and populate fields.
  
  Specified by:
  
  parseCreateField in class AbstractFieldMapper<String>
  
  Throws:
  
  IOException
- contentType
```
protected String contentType()
```
- toXContent
```
public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException
```
  Specified by:
  
  toXContent in interface ToXContent
  
  Overrides:
  
  toXContent in class AbstractFieldMapper<String>
  
  Throws:
  
  IOException
- merge
```
public void merge(Mapper mergeWith,
                  MergeContext mergeContext)
           throws MergeMappingException
```
  Specified by:
  
  merge in interface Mapper
  
  Overrides:
  
  merge in class AbstractFieldMapper<String>
  
  Throws:
  
  MergeMappingException

Class RoutingFieldMapper

Nested Class Summary

Nested Classes

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper

Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.Mapper

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

Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.FieldMapper

Field Summary

Fields

Fields inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper

Fields inherited from interface org.elasticsearch.index.mapper.Mapper

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

Fields inherited from interface org.elasticsearch.index.mapper.FieldMapper

Constructor Summary

Constructors

Method Summary

Methods inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper

Methods inherited from class java.lang.Object

Methods inherited from interface org.elasticsearch.index.mapper.Mapper

Field Detail

NAME

CONTENT_TYPE

Constructor Detail

RoutingFieldMapper

RoutingFieldMapper

Method Detail

defaultFieldType

defaultFieldDataType

hasDocValues

markAsRequired

required

path

value

value

preParse

postParse

parse

includeInObject

parseCreateField

contentType

toXContent

merge