Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class XContentDataHelper

java.lang.Object

org.elasticsearch.index.mapper.XContentDataHelper

public final class XContentDataHelper
extends Object

Helper class for processing field data of any type, as provided by the XContentParser.

Constructor Summary

Constructors

Constructor	Description
XContentDataHelper()

Method Summary

Modifier and Type	Method	Description
static org.apache.lucene.util.BytesRef	encodeXContentBuilder(XContentBuilder builder)	Build a BytesRef wrapping a byte array containing an encoded form of the passed XContentBuilder contents.
static XContentType	getXContentType(org.apache.lucene.util.BytesRef r)	Returns the XContentType to use for creating an XContentBuilder to decode the passed value.
static boolean	isDataPresent(org.apache.lucene.util.BytesRef encoded)
static org.apache.lucene.util.BytesRef	voidValue()	Returns a special encoded value that signals that this field should not be present in synthetic source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

XContentDataHelper

public XContentDataHelper()

Method Details

encodeXContentBuilder

public static org.apache.lucene.util.BytesRef encodeXContentBuilder(XContentBuilder builder)
                                                             throws IOException

Build a BytesRef wrapping a byte array containing an encoded form of the passed XContentBuilder contents.

Throws:

IOException

voidValue

public static org.apache.lucene.util.BytesRef voidValue()

Returns a special encoded value that signals that this field should not be present in synthetic source. An example is a field that has values copied to it using copy_to. While that field "looks" like a regular field it should not be present in synthetic _source same as it wouldn't be present in stored source.

Returns:

isDataPresent

public static boolean isDataPresent(org.apache.lucene.util.BytesRef encoded)

getXContentType

public static XContentType getXContentType(org.apache.lucene.util.BytesRef r)

Returns the XContentType to use for creating an XContentBuilder to decode the passed value.