Package org.elasticsearch.common.xcontent

Class AbstractObjectParser<Value,Context>

java.lang.Object

org.elasticsearch.common.xcontent.AbstractObjectParser<Value,Context>

All Implemented Interfaces:

BiFunction<XContentParser,Context,Value>, ContextParser<Context,Value>

Direct Known Subclasses:

ConstructingObjectParser, ObjectParser

public abstract class AbstractObjectParser<Value,Context>
extends Object
implements BiFunction<XContentParser,Context,Value>, ContextParser<Context,Value>

Superclass for ObjectParser and ConstructingObjectParser. Defines most of the "declare" methods so they can be shared.

Constructor Summary

Constructors

Constructor	Description
AbstractObjectParser()

Method Summary

Modifier and Type	Method	Description
void	declareBoolean(BiConsumer<Value,Boolean> consumer, ParseField field)
void	declareDouble(BiConsumer<Value,Double> consumer, ParseField field)
void	declareDoubleArray(BiConsumer<Value,List<Double>> consumer, ParseField field)
<T> void	declareField(BiConsumer<Value,T> consumer, CheckedFunction<XContentParser,T,IOException> parser, ParseField parseField, ObjectParser.ValueType type)
abstract <T> void	declareField(BiConsumer<Value,T> consumer, ContextParser<Context,T> parser, ParseField parseField, ObjectParser.ValueType type)	Declare some field.
<T> void	declareFieldArray(BiConsumer<Value,List<T>> consumer, ContextParser<Context,T> itemParser, ParseField field, ObjectParser.ValueType type)	Declares a field that can contain an array of elements listed in the type ValueType enum
void	declareFloat(BiConsumer<Value,Float> consumer, ParseField field)
void	declareFloatArray(BiConsumer<Value,List<Float>> consumer, ParseField field)
void	declareInt(BiConsumer<Value,Integer> consumer, ParseField field)
void	declareIntArray(BiConsumer<Value,List<Integer>> consumer, ParseField field)
void	declareLong(BiConsumer<Value,Long> consumer, ParseField field)
void	declareLongArray(BiConsumer<Value,List<Long>> consumer, ParseField field)
abstract <T> void	declareNamedObjects(BiConsumer<Value,List<T>> consumer, ObjectParser.NamedObjectParser<T,Context> namedObjectParser, Consumer<Value> orderedModeCallback, ParseField parseField)	Declares named objects in the style of highlighting's field element.
abstract <T> void	declareNamedObjects(BiConsumer<Value,List<T>> consumer, ObjectParser.NamedObjectParser<T,Context> namedObjectParser, ParseField parseField)	Declares named objects in the style of aggregations.
<T> void	declareObject(BiConsumer<Value,T> consumer, ContextParser<Context,T> objectParser, ParseField field)
<T> void	declareObjectArray(BiConsumer<Value,List<T>> consumer, ContextParser<Context,T> objectParser, ParseField field)
void	declareString(BiConsumer<Value,String> consumer, ParseField field)
void	declareStringArray(BiConsumer<Value,List<String>> consumer, ParseField field)
void	declareStringOrNull(BiConsumer<Value,String> consumer, ParseField field)
abstract String	getName()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiFunction

andThen, apply

Methods inherited from interface org.elasticsearch.common.xcontent.ContextParser

parse

Constructor Detail

AbstractObjectParser

public AbstractObjectParser()

Method Detail

declareField

public abstract <T> void declareField(BiConsumer<Value,T> consumer,
                                      ContextParser<Context,T> parser,
                                      ParseField parseField,
                                      ObjectParser.ValueType type)

Declare some field. Usually it is easier to use declareString(BiConsumer, ParseField) or declareObject(BiConsumer, ContextParser, ParseField) rather than call this directly.

declareNamedObjects

public abstract <T> void declareNamedObjects(BiConsumer<Value,List<T>> consumer,
                                             ObjectParser.NamedObjectParser<T,Context> namedObjectParser,
                                             ParseField parseField)

Declares named objects in the style of aggregations. These are named inside and object like this:

 
 {
   "aggregations": {
     "name_1": { "aggregation_type": {} },
     "name_2": { "aggregation_type": {} },
     "name_3": { "aggregation_type": {} }
     }
   }
 }
 
 

Unlike the other version of this method, "ordered" mode (arrays of objects) is not supported. See NamedObjectHolder in ObjectParserTests for examples of how to invoke this.

Parameters:

consumer - sets the values once they have been parsed

namedObjectParser - parses each named object

parseField - the field to parse

declareNamedObjects

public abstract <T> void declareNamedObjects(BiConsumer<Value,List<T>> consumer,
                                             ObjectParser.NamedObjectParser<T,Context> namedObjectParser,
                                             Consumer<Value> orderedModeCallback,
                                             ParseField parseField)

Declares named objects in the style of highlighting's field element. These are usually named inside and object like this:

 
 {
   "highlight": {
     "fields": {        <------ this one
       "title": {},
       "body": {},
       "category": {}
     }
   }
 }
 
 

but, when order is important, some may be written this way:

 
 {
   "highlight": {
     "fields": [        <------ this one
       {"title": {}},
       {"body": {}},
       {"category": {}}
     ]
   }
 }
 
 

This is because json doesn't enforce ordering. Elasticsearch reads it in the order sent but tools that generate json are free to put object members in an unordered Map, jumbling them. Thus, if you care about order you can send the object in the second way. See NamedObjectHolder in ObjectParserTests for examples of how to invoke this.

Parameters:

consumer - sets the values once they have been parsed

namedObjectParser - parses each named object

orderedModeCallback - called when the named object is parsed using the "ordered" mode (the array of objects)

parseField - the field to parse

getName

public abstract String getName()

declareField

public <T> void declareField(BiConsumer<Value,T> consumer,
                             CheckedFunction<XContentParser,T,IOException> parser,
                             ParseField parseField,
                             ObjectParser.ValueType type)

declareObject

public <T> void declareObject(BiConsumer<Value,T> consumer,
                              ContextParser<Context,T> objectParser,
                              ParseField field)

declareFloat

public void declareFloat(BiConsumer<Value,Float> consumer,
                         ParseField field)

declareDouble

public void declareDouble(BiConsumer<Value,Double> consumer,
                          ParseField field)

declareLong

public void declareLong(BiConsumer<Value,Long> consumer,
                        ParseField field)

declareInt

public void declareInt(BiConsumer<Value,Integer> consumer,
                       ParseField field)

declareString

public void declareString(BiConsumer<Value,String> consumer,
                          ParseField field)

declareStringOrNull

public void declareStringOrNull(BiConsumer<Value,String> consumer,
                                ParseField field)

declareBoolean

public void declareBoolean(BiConsumer<Value,Boolean> consumer,
                           ParseField field)

declareObjectArray

public <T> void declareObjectArray(BiConsumer<Value,List<T>> consumer,
                                   ContextParser<Context,T> objectParser,
                                   ParseField field)

declareStringArray

public void declareStringArray(BiConsumer<Value,List<String>> consumer,
                               ParseField field)

declareDoubleArray

public void declareDoubleArray(BiConsumer<Value,List<Double>> consumer,
                               ParseField field)

declareFloatArray

public void declareFloatArray(BiConsumer<Value,List<Float>> consumer,
                              ParseField field)

declareLongArray

public void declareLongArray(BiConsumer<Value,List<Long>> consumer,
                             ParseField field)

declareIntArray

public void declareIntArray(BiConsumer<Value,List<Integer>> consumer,
                            ParseField field)

declareFieldArray

public <T> void declareFieldArray(BiConsumer<Value,List<T>> consumer,
                                  ContextParser<Context,T> itemParser,
                                  ParseField field,
                                  ObjectParser.ValueType type)

Declares a field that can contain an array of elements listed in the type ValueType enum