All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.elasticsearch.common.xcontent.AbstractObjectParser Maven / Gradle / Ivy

There is a newer version: 8.15.1
Show newest version
/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.elasticsearch.common.xcontent;

import org.elasticsearch.common.CheckedFunction;
import org.elasticsearch.common.ParseField;
import org.elasticsearch.common.xcontent.ObjectParser.NamedObjectParser;
import org.elasticsearch.common.xcontent.ObjectParser.ValueType;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.function.BiConsumer;
import java.util.function.BiFunction;
import java.util.function.Consumer;

/**
 * Superclass for {@link ObjectParser} and {@link ConstructingObjectParser}. Defines most of the "declare" methods so they can be shared.
 */
public abstract class AbstractObjectParser
        implements BiFunction, ContextParser {

    /**
     * Declare some field. Usually it is easier to use {@link #declareString(BiConsumer, ParseField)} or
     * {@link #declareObject(BiConsumer, ContextParser, ParseField)} rather than call this directly.
     */
    public abstract  void declareField(BiConsumer consumer, ContextParser parser, ParseField parseField,
            ValueType type);

    /**
     * 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. * * @param consumer * sets the values once they have been parsed * @param namedObjectParser * parses each named object * @param parseField * the field to parse */ public abstract void declareNamedObjects(BiConsumer> consumer, NamedObjectParser namedObjectParser, 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. * * @param consumer * sets the values once they have been parsed * @param namedObjectParser * parses each named object * @param orderedModeCallback * called when the named object is parsed using the "ordered" * mode (the array of objects) * @param parseField * the field to parse */ public abstract void declareNamedObjects(BiConsumer> consumer, NamedObjectParser namedObjectParser, Consumer orderedModeCallback, ParseField parseField); public abstract String getName(); public void declareField(BiConsumer consumer, CheckedFunction parser, ParseField parseField, ValueType type) { if (parser == null) { throw new IllegalArgumentException("[parser] is required"); } declareField(consumer, (p, c) -> parser.apply(p), parseField, type); } public void declareObject(BiConsumer consumer, ContextParser objectParser, ParseField field) { declareField(consumer, (p, c) -> objectParser.parse(p, c), field, ValueType.OBJECT); } public void declareFloat(BiConsumer consumer, ParseField field) { // Using a method reference here angers some compilers declareField(consumer, p -> p.floatValue(), field, ValueType.FLOAT); } public void declareDouble(BiConsumer consumer, ParseField field) { // Using a method reference here angers some compilers declareField(consumer, p -> p.doubleValue(), field, ValueType.DOUBLE); } public void declareLong(BiConsumer consumer, ParseField field) { // Using a method reference here angers some compilers declareField(consumer, p -> p.longValue(), field, ValueType.LONG); } public void declareInt(BiConsumer consumer, ParseField field) { // Using a method reference here angers some compilers declareField(consumer, p -> p.intValue(), field, ValueType.INT); } public void declareString(BiConsumer consumer, ParseField field) { declareField(consumer, XContentParser::text, field, ValueType.STRING); } public void declareStringOrNull(BiConsumer consumer, ParseField field) { declareField(consumer, (p) -> p.currentToken() == XContentParser.Token.VALUE_NULL ? null : p.text(), field, ValueType.STRING_OR_NULL); } public void declareBoolean(BiConsumer consumer, ParseField field) { declareField(consumer, XContentParser::booleanValue, field, ValueType.BOOLEAN); } public void declareObjectArray(BiConsumer> consumer, ContextParser objectParser, ParseField field) { declareFieldArray(consumer, (p, c) -> objectParser.parse(p, c), field, ValueType.OBJECT_ARRAY); } public void declareStringArray(BiConsumer> consumer, ParseField field) { declareFieldArray(consumer, (p, c) -> p.text(), field, ValueType.STRING_ARRAY); } public void declareDoubleArray(BiConsumer> consumer, ParseField field) { declareFieldArray(consumer, (p, c) -> p.doubleValue(), field, ValueType.DOUBLE_ARRAY); } public void declareFloatArray(BiConsumer> consumer, ParseField field) { declareFieldArray(consumer, (p, c) -> p.floatValue(), field, ValueType.FLOAT_ARRAY); } public void declareLongArray(BiConsumer> consumer, ParseField field) { declareFieldArray(consumer, (p, c) -> p.longValue(), field, ValueType.LONG_ARRAY); } public void declareIntArray(BiConsumer> consumer, ParseField field) { declareFieldArray(consumer, (p, c) -> p.intValue(), field, ValueType.INT_ARRAY); } /** * Declares a field that can contain an array of elements listed in the type ValueType enum */ public void declareFieldArray(BiConsumer> consumer, ContextParser itemParser, ParseField field, ValueType type) { declareField(consumer, (p, c) -> parseArray(p, () -> itemParser.parse(p, c)), field, type); } private interface IOSupplier { T get() throws IOException; } private static List parseArray(XContentParser parser, IOSupplier supplier) throws IOException { List list = new ArrayList<>(); if (parser.currentToken().isValue() || parser.currentToken() == XContentParser.Token.VALUE_NULL || parser.currentToken() == XContentParser.Token.START_OBJECT) { list.add(supplier.get()); // single value } else { while (parser.nextToken() != XContentParser.Token.END_ARRAY) { if (parser.currentToken().isValue() || parser.currentToken() == XContentParser.Token.VALUE_NULL || parser.currentToken() == XContentParser.Token.START_OBJECT) { list.add(supplier.get()); } else { throw new IllegalStateException("expected value but got [" + parser.currentToken() + "]"); } } } return list; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy