org.elasticsearch.index.mapper.internal
Class RoutingFieldMapper

java.lang.Object
  extended by org.elasticsearch.index.mapper.core.AbstractFieldMapper<java.lang.String>
      extended by org.elasticsearch.index.mapper.internal.RoutingFieldMapper
All Implemented Interfaces:
ToXContent, FieldMapper<java.lang.String>, InternalMapper, Mapper

public class RoutingFieldMapper
extends AbstractFieldMapper<java.lang.String>
implements InternalMapper


Nested Class Summary
static class RoutingFieldMapper.Builder
           
static class RoutingFieldMapper.Defaults
           
 
Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper
AbstractFieldMapper.OpenBuilder<T extends AbstractFieldMapper.Builder,Y extends AbstractFieldMapper>
 
Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.FieldMapper
FieldMapper.Names
 
Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.Mapper
Mapper.BuilderContext, Mapper.TypeParser
 
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.MapParams, ToXContent.Params
 
Field Summary
static java.lang.String CONTENT_TYPE
           
 
Fields inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper
boost, index, indexAnalyzer, names, omitNorms, omitTermFreqAndPositions, searchAnalyzer, store, termFactory, termVector
 
Fields inherited from interface org.elasticsearch.index.mapper.Mapper
EMPTY_ARRAY
 
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
 
Constructor Summary
  RoutingFieldMapper()
           
protected RoutingFieldMapper(org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index, boolean required, java.lang.String path)
           
 
Method Summary
protected  java.lang.String contentType()
           
 java.lang.String indexedValue(java.lang.String value)
          Returns the indexed value.
 void markAsRequired()
           
 void merge(Mapper mergeWith, MergeContext mergeContext)
           
protected  org.apache.lucene.document.Field parseCreateField(ParseContext context)
           
 java.lang.String path()
           
 boolean required()
           
 XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params)
           
 void validate(ParseContext context, java.lang.String routing)
           
 java.lang.String value(org.apache.lucene.document.Document document)
           
 java.lang.String value(org.apache.lucene.document.Fieldable field)
          Returns the actual value of the field.
 java.lang.String valueAsString(org.apache.lucene.document.Fieldable field)
          Returns the actual value of the field as string.
 java.lang.String valueFromString(java.lang.String value)
           
 
Methods inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper
analyzed, boost, close, customBoost, doXContentBody, fieldDataType, fieldFilter, fieldQuery, fuzzyQuery, fuzzyQuery, index, indexAnalyzer, indexed, name, names, omitNorms, omitTermFreqAndPositions, parse, queryStringTermQuery, rangeFilter, rangeQuery, searchAnalyzer, store, stored, termVector, traverse, traverse, useFieldQueryWithQueryString, valueForSearch
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE
See Also:
Constant Field Values
Constructor Detail

RoutingFieldMapper

public RoutingFieldMapper()

RoutingFieldMapper

protected RoutingFieldMapper(org.apache.lucene.document.Field.Store store,
                             org.apache.lucene.document.Field.Index index,
                             boolean required,
                             java.lang.String path)
Method Detail

markAsRequired

public void markAsRequired()

required

public boolean required()

path

public java.lang.String path()

value

public java.lang.String value(org.apache.lucene.document.Document document)

value

public java.lang.String value(org.apache.lucene.document.Fieldable field)
Description copied from interface: FieldMapper
Returns the actual value of the field.

Specified by:
value in interface FieldMapper<java.lang.String>

valueFromString

public java.lang.String valueFromString(java.lang.String value)
Specified by:
valueFromString in interface FieldMapper<java.lang.String>

valueAsString

public java.lang.String valueAsString(org.apache.lucene.document.Fieldable field)
Description copied from interface: FieldMapper
Returns the actual value of the field as string.

Specified by:
valueAsString in interface FieldMapper<java.lang.String>

indexedValue

public java.lang.String indexedValue(java.lang.String value)
Description copied from interface: FieldMapper
Returns the indexed value.

Specified by:
indexedValue in interface FieldMapper<java.lang.String>
Overrides:
indexedValue in class AbstractFieldMapper<java.lang.String>

validate

public void validate(ParseContext context,
                     java.lang.String routing)
              throws MapperParsingException
Throws:
MapperParsingException

parseCreateField

protected org.apache.lucene.document.Field parseCreateField(ParseContext context)
                                                     throws java.io.IOException
Specified by:
parseCreateField in class AbstractFieldMapper<java.lang.String>
Throws:
java.io.IOException

contentType

protected java.lang.String contentType()
Specified by:
contentType in class AbstractFieldMapper<java.lang.String>

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException
Specified by:
toXContent in interface ToXContent
Overrides:
toXContent in class AbstractFieldMapper<java.lang.String>
Throws:
java.io.IOException

merge

public void merge(Mapper mergeWith,
                  MergeContext mergeContext)
           throws MergeMappingException
Specified by:
merge in interface Mapper
Overrides:
merge in class AbstractFieldMapper<java.lang.String>
Throws:
MergeMappingException