Package org.elasticsearch.common.xcontent

Class AbstractObjectParser<Value,​Context>

java.lang.Object
org.elasticsearch.common.xcontent.AbstractObjectParser<Value,​Context>
Direct Known Subclasses:
ConstructingObjectParser, InstantiatingObjectParser.Builder, ObjectParser
public abstract class AbstractObjectParser<Value,​Context>
extends java.lang.Object
Superclass for ObjectParser and ConstructingObjectParser. Defines most of the "declare" methods so they can be shared.

  • Constructor Details

  • Method Details

    • declareField

      public abstract <T> void declareField​(java.util.function.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.

    • declareNamedObject

      public abstract <T> void declareNamedObject​(java.util.function.BiConsumer<Value,​T> consumer, ObjectParser.NamedObjectParser<T,​Context> namedObjectParser, ParseField parseField)
      Declares a single named object. 
       
 {
   "object_name": {
     "instance_name": { "field1": "value1", ... }
     }
   }
 }
      Parameters:
      consumer - sets the value once it has been parsed
      namedObjectParser - parses the named object
      parseField - the field to parse

    • declareNamedObjects

      public abstract <T> void declareNamedObjects​(java.util.function.BiConsumer<Value,​java.util.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​(java.util.function.BiConsumer<Value,​java.util.List<T>> consumer, ObjectParser.NamedObjectParser<T,​Context> namedObjectParser, java.util.function.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 java.lang.String getName()

    • declareField

      public <T> void declareField​(java.util.function.BiConsumer<Value,​T> consumer, org.elasticsearch.common.CheckedFunction<XContentParser,​T,​java.io.IOException> parser, ParseField parseField, ObjectParser.ValueType type)

    • declareObject

      public <T> void declareObject​(java.util.function.BiConsumer<Value,​T> consumer, ContextParser<Context,​T> objectParser, ParseField field)

    • declareObjectOrNull

      public <T> void declareObjectOrNull​(java.util.function.BiConsumer<Value,​T> consumer, ContextParser<Context,​T> objectParser, T nullValue, ParseField field)
      Declare an object field that parses explicit nulls in the json to a default value.

    • declareFloat

      public void declareFloat​(java.util.function.BiConsumer<Value,​java.lang.Float> consumer, ParseField field)

    • declareFloatOrNull

      public void declareFloatOrNull​(java.util.function.BiConsumer<Value,​java.lang.Float> consumer, float nullValue, ParseField field)
      Declare a float field that parses explicit nulls in the json to a default value.

    • declareDouble

      public void declareDouble​(java.util.function.BiConsumer<Value,​java.lang.Double> consumer, ParseField field)

    • declareDoubleOrNull

      public void declareDoubleOrNull​(java.util.function.BiConsumer<Value,​java.lang.Double> consumer, double nullValue, ParseField field)
      Declare a double field that parses explicit nulls in the json to a default value.

    • declareLong

      public void declareLong​(java.util.function.BiConsumer<Value,​java.lang.Long> consumer, ParseField field)

    • declareInt

      public void declareInt​(java.util.function.BiConsumer<Value,​java.lang.Integer> consumer, ParseField field)

    • declareIntOrNull

      public void declareIntOrNull​(java.util.function.BiConsumer<Value,​java.lang.Integer> consumer, int nullValue, ParseField field)
      Declare a double field that parses explicit nulls in the json to a default value.

    • declareString

      public void declareString​(java.util.function.BiConsumer<Value,​java.lang.String> consumer, ParseField field)

    • declareStringOrNull

      public void declareStringOrNull​(java.util.function.BiConsumer<Value,​java.lang.String> consumer, ParseField field)

    • declareBoolean

      public void declareBoolean​(java.util.function.BiConsumer<Value,​java.lang.Boolean> consumer, ParseField field)

    • declareObjectArray

      public <T> void declareObjectArray​(java.util.function.BiConsumer<Value,​java.util.List<T>> consumer, ContextParser<Context,​T> objectParser, ParseField field)

    • declareObjectArrayOrNull

      public <T> void declareObjectArrayOrNull​(java.util.function.BiConsumer<Value,​java.util.List<T>> consumer, ContextParser<Context,​T> objectParser, ParseField field)
      like declareObjectArray(BiConsumer, ContextParser, ParseField), but can also handle single null values, in which case the consumer isn't called

    • declareStringArray

      public void declareStringArray​(java.util.function.BiConsumer<Value,​java.util.List<java.lang.String>> consumer, ParseField field)

    • declareDoubleArray

      public void declareDoubleArray​(java.util.function.BiConsumer<Value,​java.util.List<java.lang.Double>> consumer, ParseField field)

    • declareFloatArray

      public void declareFloatArray​(java.util.function.BiConsumer<Value,​java.util.List<java.lang.Float>> consumer, ParseField field)

    • declareLongArray

      public void declareLongArray​(java.util.function.BiConsumer<Value,​java.util.List<java.lang.Long>> consumer, ParseField field)

    • declareIntArray

      public void declareIntArray​(java.util.function.BiConsumer<Value,​java.util.List<java.lang.Integer>> consumer, ParseField field)

    • declareFieldArray

      public <T> void declareFieldArray​(java.util.function.BiConsumer<Value,​java.util.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

    • declareRequiredFieldSet

      public abstract void declareRequiredFieldSet​(java.lang.String... requiredSet)
      Declares a set of fields that are required for parsing to succeed. Only one of the values provided per String[] must be matched. E.g. declareRequiredFieldSet("foo", "bar"); means at least one of "foo" or "bar" fields must be present. If neither of those fields are present, an exception will be thrown. Multiple required sets can be configured: 
      
   parser.declareRequiredFieldSet("foo", "bar");
   parser.declareRequiredFieldSet("bizz", "buzz");
      requires that one of "foo" or "bar" fields are present, and also that one of "bizz" or "buzz" fields are present. In JSON, it means any of these combinations are acceptable:
      • {"foo":"...", "bizz": "..."}
      • {"bar":"...", "bizz": "..."}
      • {"foo":"...", "buzz": "..."}
      • {"bar":"...", "buzz": "..."}
      • {"foo":"...", "bar":"...", "bizz": "..."}
      • {"foo":"...", "bar":"...", "buzz": "..."}
      • {"foo":"...", "bizz":"...", "buzz": "..."}
      • {"bar":"...", "bizz":"...", "buzz": "..."}
      • {"foo":"...", "bar":"...", "bizz": "...", "buzz": "..."}
      The following would however be rejected:
      failure cases
      Provided JSONReason for failure
      {"foo":"..."}Missing "bizz" or "buzz" field
      {"bar":"..."}Missing "bizz" or "buzz" field
      {"bizz": "..."}Missing "foo" or "bar" field
      {"buzz": "..."}Missing "foo" or "bar" field
      {"foo":"...", "bar": "..."}Missing "bizz" or "buzz" field
      {"bizz":"...", "buzz": "..."}Missing "foo" or "bar" field
      {"unrelated":"..."} Missing "foo" or "bar" field, and missing "bizz" or "buzz" field
      Parameters:
      requiredSet - A set of required fields, where at least one of the fields in the array _must_ be present

    • declareExclusiveFieldSet

      public abstract void declareExclusiveFieldSet​(java.lang.String... exclusiveSet)
      Declares a set of fields of which at most one must appear for parsing to succeed E.g. declareExclusiveFieldSet("foo", "bar"); means that only one of 'foo' or 'bar' must be present, and if both appear then an exception will be thrown. Note that this does not make 'foo' or 'bar' required - see declareRequiredFieldSet(String...) for required fields. Multiple exclusive sets may be declared
      Parameters:
      exclusiveSet - a set of field names, at most one of which must appear