com.yahoo.vespa.documentmodel.SearchDef 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.409.18
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.documentmodel;

import com.yahoo.document.DocumentType;
import com.yahoo.document.DocumentTypeManager;

import java.util.HashMap;
import java.util.Map;
import java.util.logging.Logger;

/**
 * @author    baldersheim
 * @since     2010-02-19
 */
public class SearchDef {
    private final static Logger log = Logger.getLogger(SearchDef.class.getName());
    /// Name of the searchdefinition
    private String name;
    /// These are the real backing documenttypes
    private DocumentTypeManager sources = new DocumentTypeManager();
    /// Map of all search fields
    private Map fields = new HashMap<>();
    /// Map of all views that can be searched.
    private Map views = new HashMap<>();
    /// Map of all aliases 
    private Map aliases = new HashMap<>();

    /**
     * Will create a SearchDef with the given name
     * @param name The name of the searchdefinition
     */
    public SearchDef(String name) {
        this.name = name;
    }

    /**
     * This will provide you with the name of the searchdefinition.
     * @return The name of the searchdefinition.
     */
    public String getName() { return name; }

    public Map getFields() { return fields; }
    public Map getViews() { return views; }

    /**
     * Adds a document that can be mapped to this search.
     * @param source A document that can be mapped to this search.
     * @return Itself for chaining.
     */
    public SearchDef add(DocumentType source) {
        sources.registerDocumentType(source);
        return this;
    }

    private void noShadowing(String name) {
        noFieldShadowing(name);
        noViewShadowing(name);
    }

    private void noFieldShadowing(String name) {
        if (fields.containsKey(name)) {
            throw new IllegalArgumentException("Searchdef '" + getName() + "' already contains the fields '" + fields.toString() +
                    "'. You are trying to add '" + name + "'. Shadowing is not supported");
        }
    }

    private void noViewShadowing(String name) {
        if (views.containsKey(name)) {
            throw new IllegalArgumentException("Searchdef '" + getName() + "' already contains a view with name '" +
                    name + "'. Shadowing is not supported.");
        }
    }

    /**
     * Adds a search field to the definition.
     * @param field The field to add.
     * @return Itself for chaining.
     */
    public SearchDef add(SearchField field) {
        try {
            noFieldShadowing(field.getName());
            fields.put(field.getName(), field);
        } catch (IllegalArgumentException e) {
            if (views.containsKey(field.getName())) {
                 throw e;
            }
        }
        return this;
    }

    public SearchDef addAlias(String alias, String aliased) {
        noShadowing(alias);
        if (!fields.containsKey(aliased) && !views.containsKey(aliased)) {
            if (aliased.contains(".")) {
                // TODO Here we should nest ourself down to something that really exists.
                log.warning("Aliased item '" + aliased + "' not verifiable. Allowing it to be aliased to '" + alias + " for now. Validation will come when URL/Position is structified.");
            } else {
                throw new IllegalArgumentException("Searchdef '" + getName() + "' has nothing named '" + aliased + "'to alias to '" + alias + "'.");
            }
        }
        String oldAliased = aliases.get(alias);
        if ((oldAliased != null)) {
            if (oldAliased.equals(aliased)) {
                throw new IllegalArgumentException("Searchdef '" + getName() + "' already has the alias '" + alias +
                        "' to '" + aliased + ". Why do you want to add it again.");

            } else {
                throw new IllegalArgumentException("Searchdef '" + getName() + "' already has the alias '" + alias +
                        "' to '" + oldAliased + ". Cannot change it to alias '" + aliased + "'.");
            }
        } else {
            aliases.put(alias, aliased);
        }
        return this;
    }

    public SearchDef add(FieldView view) {
        noViewShadowing(view.getName());
        if (views.containsKey(view.getName())) {
            views.get(view.getName()).add(view);
        }
        views.put(view.getName(), view);
        return this;
    }
}