com.yelp.nrtsearch.server.similarity.SimilarityProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of server Show documentation

GRPC lucene server using near-real-time replication

There is a newer version: 1.0.0-beta.1

/*
 * Copyright 2020 Yelp Inc.
 *
 * Licensed 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 com.yelp.nrtsearch.server.similarity;

import java.util.Map;
import org.apache.lucene.search.similarities.Similarity;

/**
 * Interface for getting a {@link Similarity} implementation initialized with the given parameters
 * map.
 *
 * @param  similarity type
 */
@FunctionalInterface
public interface SimilarityProvider {

  /**
   * Get a {@link Similarity} implementation initialized with the given parameters.
   *
   * @param params java native similarity parameters decoded from {@link
   *     com.yelp.nrtsearch.server.grpc.Field}
   * @return similarity instance
   */
  T get(Map params);
}