com.twitter.elephantbird.util.Inflection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of elephant-bird-core Show documentation
Core utilities.
The newest version!
package com.twitter.elephantbird.util;

import java.util.List;
import java.util.ArrayList;
import java.util.regex.Pattern;

/**
 * Handles singularization and pluralization.
 *
 * Largely taken from the defunct rogueweb project at
 * http://code.google.com/p/rogueweb/
 * Original author Anthony Eden.
 */

public class Inflection {
  private static final List plurals_ = new ArrayList();
  private static final List singulars_ = new ArrayList();
  private static final List uncountables_ = new ArrayList();

  static {
    // plural is "singular to plural form"
    // singular is "plural to singular form"
    plural("$", "s");
    plural("s$", "s");
    plural("(ax|test)is$", "$1es");
    plural("(octop|vir)us$", "$1i");
    plural("(alias|status)$", "$1es");
    plural("(bu)s$", "$1ses");
    plural("(buffal|tomat)o$", "$1oes");
    plural("([ti])um$", "$1a");
    plural("sis$", "ses");
    plural("(?:([^f])fe|([lr])f)$", "$1$2ves");
    plural("(hive)$", "$1s");
    plural("([^aeiouy]|qu)y$", "$1ies");
    // plural("([^aeiouy]|qu)ies$", "$1y");
    plural("(x|ch|ss|sh)$", "$1es");
    plural("(matr|vert|ind)ix|ex$", "$1ices");
    plural("([m|l])ouse$", "$1ice");
    plural("^(ox)$", "$1en");
    plural("(quiz)$", "$1zes");

    singular("s$", "");
    singular("(n)ews$", "$1ews");
    singular("([ti])a$", "$1um");
    singular("((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$", "$1$2sis");
    singular("(^analy)ses$", "$1sis");
    singular("([^f])ves$", "$1fe");
    singular("(hive)s$", "$1");
    singular("(tive)s$", "$1");
    singular("([lr])ves$", "$1f");
    singular("([^aeiouy]|qu)ies$", "$1y");
    singular("(s)eries$", "$1eries");
    singular("(m)ovies$", "$1ovie");
    singular("(x|ch|ss|sh)es$", "$1");
    singular("([m|l])ice$", "$1ouse");
    singular("(bus)es$", "$1");
    singular("(o)es$", "$1");
    singular("(shoe)s$", "$1");
    singular("(cris|ax|test)es$", "$1is");
    singular("(octop|vir)i$", "$1us");
    singular("(alias|status)es$", "$1");
    singular("^(ox)en", "$1");
    singular("(vert|ind)ices$", "$1ex");
    singular("(matr)ices$", "$1ix");
    singular("(quiz)zes$", "$1");

    irregular("person", "people");
    irregular("man", "men");
    irregular("child", "children");
    irregular("sex", "sexes");
    irregular("move", "moves");

    uncountable("equipment");
    uncountable("information");
    uncountable("rice");
    uncountable("money");
    uncountable("species");
    uncountable("series");
    uncountable("fish");
    uncountable("sheep");
  }

  private String pattern_;
  private String replacement_;
  private boolean ignoreCase_;

  public Inflection(String pattern) {
    this(pattern, null, true);
  }

  public Inflection(String pattern, String replacement) {
    this(pattern, replacement, true);
  }

  public Inflection(String pattern, String replacement, boolean ignoreCase) {
    pattern_ = pattern;
    replacement_ = replacement;
    ignoreCase_ = ignoreCase;
  }

  private static void plural(String pattern, String replacement) {
    plurals_.add(0, new Inflection(pattern, replacement));
  }

  private static void singular(String pattern, String replacement) {
    singulars_.add(0, new Inflection(pattern, replacement));
  }

  private static void irregular(String s, String p) {
    plural("(" + s.substring(0, 1) + ")" + s.substring(1) + "$", "$1" + p.substring(1));
    singular("(" + p.substring(0, 1) + ")" + p.substring(1) + "$", "$1" + s.substring(1));
  }

  private static void uncountable(String word) {
    uncountables_.add(word);
  }

  /**
   * Does the given word match?
   * @param word The word
   * @return True if it matches the inflection pattern
   */
  public boolean match(String word) {
    int flags = ignoreCase_ ? Pattern.CASE_INSENSITIVE : 0;
    return Pattern.compile(pattern_, flags).matcher(word).find();
  }

  /**
   * Replace the word with its pattern.
   * @param word The word
   * @return The result
   */
  public String replace(String word) {
    int flags = ignoreCase_ ? Pattern.CASE_INSENSITIVE : 0;
    return Pattern.compile(pattern_, flags).matcher(word).replaceAll(replacement_);
  }

  /**
   * Return the pluralized version of a word.
   * @param word The word
   * @return The pluralized word
   */
  public static String pluralize(String word) {
    if (isUncountable(word)) {
      return word;
    } else {
      for (Inflection inflection : plurals_) {
        if (inflection.match(word)) {
          return inflection.replace(word);
        }
      }
      return word;
    }
  }

  /**
   * Return the singularized version of a word.
   * @param word The word
   * @return The singularized word
   */
  public static String singularize(String word) {
    if (isUncountable(word)) {
      return word;
    } else {
      for (Inflection inflection : singulars_) {
        if (inflection.match(word)) {
          return inflection.replace(word);
        }
      }
    }
    return word;
  }

  /**
   * Return true if the word is uncountable.
   * @param word The word
   * @return True if it is uncountable
   */
  public static boolean isUncountable(String word) {
    for (String w : uncountables_) {
      if (w.equalsIgnoreCase(word)) {
        return true;
      }
    }
    return false;
  }

}