com.yahoo.schema.derived.ImportedFields 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.458.13
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.schema.derived;

import com.yahoo.schema.Schema;
import com.yahoo.schema.document.Attribute;
import com.yahoo.schema.document.GeoPos;
import com.yahoo.schema.document.ImmutableSDField;
import com.yahoo.schema.document.ImportedComplexField;
import com.yahoo.schema.document.ImportedField;
import com.yahoo.vespa.config.search.ImportedFieldsConfig;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;

import static com.yahoo.schema.document.ComplexAttributeFieldUtils.isArrayOfSimpleStruct;
import static com.yahoo.schema.document.ComplexAttributeFieldUtils.isMapOfPrimitiveType;
import static com.yahoo.schema.document.ComplexAttributeFieldUtils.isMapOfSimpleStruct;

/**
 * This class derives imported fields from search definition and produces imported-fields.cfg as needed by the search backend.
 *
 * @author geirst
 */
public class ImportedFields extends Derived {

    private Optional importedFields = Optional.empty();

    public ImportedFields(Schema schema) {
        derive(schema);
    }

    @Override
    protected void derive(Schema schema) {
        importedFields = schema.importedFields();
    }

    @Override
    protected String getDerivedName() {
        return "imported-fields";
    }

    public void getConfig(ImportedFieldsConfig.Builder builder) {
        // Replace
        if (importedFields.isPresent()) {
            List imported = new ArrayList<>();
            importedFields.get().fields().forEach( (name, field) -> considerField(imported, field));
            builder.attribute(imported.stream().map(ImportedFields::createAttributeBuilder).toList());
        }
    }

    public void export(String toDirectory) throws IOException {
        var builder = new ImportedFieldsConfig.Builder();
        getConfig(builder);
        export(toDirectory, builder.build());
    }

    private static boolean isNestedFieldName(String fieldName) {
        return fieldName.indexOf('.') != -1;
    }

    private static void considerField(List importedFields, ImportedField field) {
        if (field instanceof ImportedComplexField) {
            considerComplexField(importedFields, (ImportedComplexField) field);
        } else {
            considerSimpleField(importedFields, field);
        }
    }

    private static void considerComplexField(List importedFields, ImportedComplexField field) {
        ImmutableSDField targetField = field.targetField();
        if (GeoPos.isAnyPos(targetField)) {
            // no action needed
        } else if (isArrayOfSimpleStruct(targetField)) {
            considerNestedFields(importedFields, field);
        } else if (isMapOfSimpleStruct(targetField)) {
            considerSimpleField(importedFields, field.getNestedField("key"));
            considerNestedFields(importedFields, field.getNestedField("value"));
        } else if (isMapOfPrimitiveType(targetField)) {
            considerSimpleField(importedFields, field.getNestedField("key"));
            considerSimpleField(importedFields, field.getNestedField("value"));
        }
    }

    private static void considerNestedFields(List importedFields, ImportedField field) {
        if (field instanceof ImportedComplexField complexField) {
            complexField.getNestedFields().forEach(nestedField -> considerSimpleField(importedFields, nestedField));
        }
    }

    private static void considerSimpleField(List importedFields, ImportedField field) {
        ImmutableSDField targetField = field.targetField();
        String targetFieldName = targetField.getName();
        if (!isNestedFieldName(targetFieldName)) {
            if (targetField.doesAttributing()) {
                importedFields.add(field);
            }
        } else {
            Attribute attribute = targetField.getAttribute();
            if (attribute != null) {
                importedFields.add(field);
            }
        }
    }

    private static ImportedFieldsConfig.Attribute.Builder createAttributeBuilder(ImportedField field) {
        ImportedFieldsConfig.Attribute.Builder result = new ImportedFieldsConfig.Attribute.Builder();
        result.name(field.fieldName());
        result.referencefield(field.reference().referenceField().getName());
        result.targetfield(field.targetField().getName());
        return result;
    }

}