org.elasticsearch.index.mapper.MapperBuilderContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation

Elasticsearch - Open Source, Distributed, RESTful Search Engine

There is a newer version: 9.0.0-beta1

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.index.mapper;

import org.elasticsearch.common.Strings;

import java.util.Objects;
import java.util.function.BooleanSupplier;

/**
 * Holds context for building Mapper objects from their Builders
 */
public class MapperBuilderContext {

    /**
     * The root context, to be used when building a tree of mappers
     */
    public static MapperBuilderContext root(boolean isSourceSynthetic) {
        return new MapperBuilderContext(null, () -> isSourceSynthetic);
    }

    /**
     * A context to use to build metadata fields.
     */
    public static MapperBuilderContext forMetadata() {
        return new MapperBuilderContext(null, () -> {
            throw new UnsupportedOperationException("metadata fields can't check if _source is synthetic");
        });
    }

    private final String path;
    private final BooleanSupplier isSourceSynthetic;

    MapperBuilderContext(String path, boolean isSourceSynthetic) {
        this(Objects.requireNonNull(path), () -> isSourceSynthetic);
    }

    private MapperBuilderContext(String path, BooleanSupplier isSourceSynthetic) {
        this.path = path;
        this.isSourceSynthetic = isSourceSynthetic;
    }

    /**
     * Creates a new MapperBuilderContext that is a child of this context
     * @param name the name of the child context
     * @return a new MapperBuilderContext with this context as its parent
     */
    public MapperBuilderContext createChildContext(String name) {
        return new MapperBuilderContext(buildFullName(name), isSourceSynthetic);
    }

    /**
     * Builds the full name of the field, taking into account parent objects
     */
    public String buildFullName(String name) {
        if (Strings.isEmpty(path)) {
            return name;
        }
        return path + "." + name;
    }

    /**
     * Is the {@code _source} field being reconstructed on the fly?
     */
    public boolean isSourceSynthetic() {
        return isSourceSynthetic.getAsBoolean();
    }
}