org.opensearch.search.fetch.subphase.FetchDocValuesContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensearch Show documentation
OpenSearch subproject :server
There is a newer version: 2.18.0
/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 */

/*
 * 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.
 */
/*
 * Modifications Copyright OpenSearch Contributors. See
 * GitHub history for details.
 */

package org.opensearch.search.fetch.subphase;

import org.opensearch.index.IndexSettings;
import org.opensearch.index.mapper.MapperService;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

/**
 * All the required context to pull a field from the doc values.
 */
public class FetchDocValuesContext {
    private final List fields;

    public static FetchDocValuesContext create(MapperService mapperService, List fieldPatterns) {
        List fields = new ArrayList<>();
        for (FieldAndFormat field : fieldPatterns) {
            Collection fieldNames = mapperService.simpleMatchToFullName(field.field);
            for (String fieldName : fieldNames) {
                fields.add(new FieldAndFormat(fieldName, field.format));
            }
        }
        int maxAllowedDocvalueFields = mapperService.getIndexSettings().getMaxDocvalueFields();
        if (fields.size() > maxAllowedDocvalueFields) {
            throw new IllegalArgumentException(
                "Trying to retrieve too many docvalue_fields. Must be less than or equal to: ["
                    + maxAllowedDocvalueFields
                    + "] but was ["
                    + fields.size()
                    + "]. This limit can be set by changing the ["
                    + IndexSettings.MAX_DOCVALUE_FIELDS_SEARCH_SETTING.getKey()
                    + "] index level setting."
            );
        }

        return new FetchDocValuesContext(fields);
    }

    public FetchDocValuesContext(List fields) {
        this.fields = fields;
    }

    /**
     * Returns the required docvalue fields
     */
    public List fields() {
        return this.fields;
    }
}