summaryrefslogtreecommitdiff
path: root/core/src/main/java/org/elasticsearch/index/similarity/SimilarityProvider.java
blob: 6c8a17f99a5331781fe59a61622d429f266ebc41 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/*
 * 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 org.apache.lucene.search.similarities.Similarity;

/**
 * Provider for {@link Similarity} instances
 */
public interface SimilarityProvider {

    /**
     * Returns the name associated with the Provider
     *
     * @return Name of the Provider
     */
    String name();

    /**
     * Returns the {@link Similarity} the Provider is for
     *
     * @return Provided {@link Similarity}
     */
    Similarity get();
}