org.elasticsearch.index.mapper.xcontent
Class XContentIdFieldMapper

java.lang.Object
  extended by org.elasticsearch.index.mapper.xcontent.XContentFieldMapper<java.lang.String>
      extended by org.elasticsearch.index.mapper.xcontent.XContentIdFieldMapper
All Implemented Interfaces:
ToXContent, FieldMapper<java.lang.String>, IdFieldMapper, InternalMapper, XContentMapper

public class XContentIdFieldMapper
extends XContentFieldMapper<java.lang.String>
implements IdFieldMapper


Nested Class Summary
static class XContentIdFieldMapper.Builder
           
static class XContentIdFieldMapper.Defaults
           
 
Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.xcontent.XContentFieldMapper
XContentFieldMapper.OpenBuilder<T extends XContentFieldMapper.Builder,Y extends XContentFieldMapper>
 
Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.FieldMapper
FieldMapper.Names
 
Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.xcontent.XContentMapper
XContentMapper.BuilderContext
 
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.xcontent.XContentFieldMapper
boost, index, indexAnalyzer, names, omitNorms, omitTermFreqAndPositions, searchAnalyzer, store, termVector
 
Fields inherited from interface org.elasticsearch.index.mapper.xcontent.XContentMapper
EMPTY_ARRAY
 
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
 
Constructor Summary
protected XContentIdFieldMapper()
           
protected XContentIdFieldMapper(java.lang.String name, java.lang.String indexName)
           
protected XContentIdFieldMapper(java.lang.String name, java.lang.String indexName, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.TermVector termVector, float boost, boolean omitNorms, boolean omitTermFreqAndPositions)
           
 
Method Summary
protected  java.lang.String contentType()
           
 java.lang.String indexedValue(java.lang.String value)
          Returns the indexed value.
 void merge(XContentMapper mergeWith, MergeContext mergeContext)
           
protected  org.apache.lucene.document.Field parseCreateField(ParseContext context)
           
 void toXContent(XContentBuilder builder, ToXContent.Params params)
           
 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.xcontent.XContentFieldMapper
analyzed, boost, doXContentBody, fieldDataType, fieldFilter, fieldQuery, index, indexAnalyzer, indexed, name, names, omitNorms, omitTermFreqAndPositions, parse, queryStringTermQuery, rangeFilter, rangeQuery, searchAnalyzer, store, stored, termVector, traverse, useFieldQueryWithQueryString, valueForSearch
 
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.FieldMapper
analyzed, boost, fieldDataType, fieldFilter, fieldQuery, index, indexAnalyzer, indexed, names, omitNorms, omitTermFreqAndPositions, queryStringTermQuery, rangeFilter, rangeQuery, searchAnalyzer, store, stored, termVector, useFieldQueryWithQueryString, valueForSearch
 

Field Detail

CONTENT_TYPE

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

XContentIdFieldMapper

protected XContentIdFieldMapper()

XContentIdFieldMapper

protected XContentIdFieldMapper(java.lang.String name,
                                java.lang.String indexName)

XContentIdFieldMapper

protected XContentIdFieldMapper(java.lang.String name,
                                java.lang.String indexName,
                                org.apache.lucene.document.Field.Store store,
                                org.apache.lucene.document.Field.TermVector termVector,
                                float boost,
                                boolean omitNorms,
                                boolean omitTermFreqAndPositions)
Method Detail

value

public java.lang.String value(org.apache.lucene.document.Document document)
Specified by:
value in interface IdFieldMapper

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 XContentFieldMapper<java.lang.String>

parseCreateField

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

contentType

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

toXContent

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

merge

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