← Back to branch summary

~slub.team/goobi-indexserver/3.x

« back to all changes in this revision

Viewing changes to lucene/contrib/spellchecker/src/java/org/apache/lucene/search/spell/StringDistance.java

  • Committer: Sebastian Meyer
  • Date: 2012-08-03 09:12:40 UTC
  • Revision ID: sebastian.meyer@slub-dresden.de-20120803091240-x6861b0vabq1xror
https://launchpad.net/bugs/985487
Remove Lucene and Solr source code and add patches instead
Fix Bug #985487: Auto-suggestion for the search interface

Show diffs side-by-side

added added

removed removed

Lines of Context:
lucene/contrib/spellchecker/src/java/org/apache/lucene/search/spell/StringDistance.java
1
 
package org.apache.lucene.search.spell;
2
 
 
3
 
/**
4
 
 * Licensed to the Apache Software Foundation (ASF) under one or more
5
 
 * contributor license agreements.  See the NOTICE file distributed with
6
 
 * this work for additional information regarding copyright ownership.
7
 
 * The ASF licenses this file to You under the Apache License, Version 2.0
8
 
 * (the "License"); you may not use this file except in compliance with
9
 
 * the License.  You may obtain a copy of the License at
10
 
 *
11
 
 *     http://www.apache.org/licenses/LICENSE-2.0
12
 
 *
13
 
 * Unless required by applicable law or agreed to in writing, software
14
 
 * distributed under the License is distributed on an "AS IS" BASIS,
15
 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
 
 * See the License for the specific language governing permissions and
17
 
 * limitations under the License.
18
 
 */
19
 
 
20
 
/**
21
 
 * Interface for string distances.
22
 
 */
23
 
public interface StringDistance {
24
 
 
25
 
  /**
26
 
   * Returns a float between 0 and 1 based on how similar the specified strings are to one another.  
27
 
   * Returning a value of 1 means the specified strings are identical and 0 means the
28
 
   * string are maximally different.
29
 
   * @param s1 The first string.
30
 
   * @param s2 The second string.
31
 
   * @return a float between 0 and 1 based on how similar the specified strings are to one another.
32
 
   */
33
 
  public float getDistance(String s1,String s2);
34
 
  
35
 
}