com.yahoo.schema.processing.SummaryDynamicStructsArrays Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of config-model Show documentation

There is a newer version: 8.441.21

// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.schema.processing;


import com.yahoo.config.application.api.DeployLogger;
import com.yahoo.schema.RankProfileRegistry;
import com.yahoo.document.*;
import com.yahoo.schema.Schema;
import com.yahoo.schema.document.SDField;
import com.yahoo.vespa.documentmodel.SummaryField;
import com.yahoo.vespa.documentmodel.SummaryTransform;
import com.yahoo.vespa.model.container.search.QueryProfiles;

/**
 * Fail if:
 * An SD field explicitly says summary:dynamic , but the field is non-string array, wset, or struct.
 * If there is an explicitly defined summary class, saying dynamic in one of its summary
 * fields is always legal.
 *
 * @author Vegard Havdal
 */
public class SummaryDynamicStructsArrays extends Processor {

    public SummaryDynamicStructsArrays(Schema schema, DeployLogger deployLogger, RankProfileRegistry rankProfileRegistry, QueryProfiles queryProfiles) {
        super(schema, deployLogger, rankProfileRegistry, queryProfiles);
    }

    @Override
    public void process(boolean validate, boolean documentsOnly) {
        if ( ! validate) return;

        for (SDField field : schema.allConcreteFields()) {
            DataType type = field.getDataType();
            if (isNonStringArray(type) || type instanceof WeightedSetDataType || type instanceof StructDataType) {
                for (SummaryField sField : field.getSummaryFields().values()) {
                    if (sField.getTransform().equals(SummaryTransform.DYNAMICTEASER)) {
                        throw new IllegalArgumentException("For field '"+field.getName()+"': dynamic summary is illegal " +
                                                           "for fields of type struct, array or weighted set. Use an " +
                                                           "explicit summary class with explicit summary fields sourcing" +
                                                           " from the array/struct/weighted set.");
                    }
                }
            }
        }
    }

    private boolean isNonStringArray(DataType type) {
        return (type instanceof ArrayDataType) && (!type.equals(DataType.getArray(DataType.STRING)));
    }

}