SoundexMethod.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Subproject: Position of fragment of text in XML document
 * Authors: Michael Angelov
 * File: SoundexMethod.java
 * Description: Compare class using Soundex approximate string matching method
 */

/**
 * @file SoundexMethod.java
 *
 * @brief Compare class using Soundex approximate string matching method
 */

package cz.vutbr.fit.knot.annotations.fragmentUpdater.compareMethods;

import org.apache.commons.codec.language.Soundex;

/**
 * Compare class using Soundex approximate string matching method
 *
 * @brief Compare class using Soundex approximate string matching method
 * @author Michael Angelov
 */
public class SoundexMethod extends CompareMethod {

  /**
   * String comparison method using Soundex encoding of strings
   *
   * @param first first string to compare
   * @param second second string to compare
   * @return true if strings match, false if don't
   */
  @Override
  public boolean compare(String first, String second) {
    if (second == null) {
      return false;
    }
    Soundex soundex = new Soundex();

    String[] firstWords = first.split("\\s+");
    String[] secondWords = second.split("\\s+");

    // iterate through all the words of first and second string
    int i = 0;
    while (i < firstWords.length && i < secondWords.length) {
      // if one pair of words doesn't match, strings don't match, return false
      if (!soundex.encode(firstWords[i]).equals(soundex.encode(secondWords[i]))) {
        return false;
      }
      i++;
    }

    // everything went ok, words of string match
    return true;
  }

  /**
   * Overriden toString() method
   *
   * @return string representation of class
   */
  @Override
  public String toString() {
    return "Soundex";
  }
}  // class SoundexMethod