org.elasticsearch.index.similarity.SimilarityLookupService Maven / Gradle / Ivy

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: 8.14.1
/*
 * 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.
 */

package org.elasticsearch.index.similarity;

import com.google.common.collect.ImmutableMap;
import org.elasticsearch.common.collect.MapBuilder;
import org.elasticsearch.common.inject.Inject;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.index.AbstractIndexComponent;
import org.elasticsearch.index.Index;
import org.elasticsearch.index.settings.IndexSettingsService;

import java.util.Map;

/**
 * Service for looking up configured {@link SimilarityProvider} implementations by name.
 * 
 * The service instantiates the Providers through their Factories using configuration
 * values found with the {@link SimilarityModule#SIMILARITY_SETTINGS_PREFIX} prefix.
 */
public class SimilarityLookupService extends AbstractIndexComponent {

    public final static String DEFAULT_SIMILARITY = "default";

    private final ImmutableMap similarities;

    public SimilarityLookupService(Index index, Settings indexSettings) {
        this(index, indexSettings, ImmutableMap.of());
    }

    @Inject
    public SimilarityLookupService(Index index, IndexSettingsService indexSettingsService, Map similarities) {
        this(index, indexSettingsService.getSettings(), similarities);
    }

    private SimilarityLookupService(Index index, Settings indexSettings, Map similarities) {
        super(index, indexSettings);

        MapBuilder providers = MapBuilder.newMapBuilder();

        Map similaritySettings = indexSettings.getGroups(SimilarityModule.SIMILARITY_SETTINGS_PREFIX);
        for (Map.Entry entry : similarities.entrySet()) {
            String name = entry.getKey();
            SimilarityProvider.Factory factory = entry.getValue();

            Settings settings = similaritySettings.get(name);
            if (settings == null) {
                settings = Settings.Builder.EMPTY_SETTINGS;
            }
            providers.put(name, factory.create(name, settings));
        }

        // For testing
        for (PreBuiltSimilarityProvider.Factory factory : Similarities.listFactories()) {
            if (!providers.containsKey(factory.name())) {
                providers.put(factory.name(), factory.get());
            }
        }

        this.similarities = providers.immutableMap();
    }

    /**
     * Returns the {@link SimilarityProvider} with the given name
     *
     * @param name Name of the SimilarityProvider to find
     * @return {@link SimilarityProvider} with the given name, or {@code null} if no Provider exists
     */
    public SimilarityProvider similarity(String name) {
        return similarities.get(name);
    }
}