org.apache.commons.codec.language
Class Caverphone

java.lang.Object
  org.apache.commons.codec.language.Caverphone

All Implemented Interfaces:

Encoder, StringEncoder

public class Caverphone
extends Object
implements StringEncoder

Encodes a string into a Caverphone value. This is an algorithm created the Caversham Project at the University of Otago. It implements the Caverphone 2.0 algorithm:

Since:

1.4

Version:

$Id: Caverphone.java 797690 2009-07-24 23:28:35Z ggregory $

Author:

Apache Software Foundation

See Also:

Wikipedia - Caverphone, Caverphone 2.0 specification

Constructor Summary

Caverphone()
Creates an instance of the Caverphone encoder

Method Summary

String	caverphone(String txt) Find the caverphone value of a String.
Object	encode(Object pObject) Encodes an Object using the caverphone algorithm.
String	encode(String pString) Encodes a String using the Caverphone algorithm.
boolean	isCaverphoneEqual(String str1, String str2) Tests if the caverphones of two strings are identical.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Caverphone

public Caverphone()

Creates an instance of the Caverphone encoder

Method Detail

caverphone

public String caverphone(String txt)

Find the caverphone value of a String.

Parameters:

txt - String to find the caverphone code for

Returns:

A caverphone code corresponding to the String supplied

encode

public Object encode(Object pObject)
              throws EncoderException

Encodes an Object using the caverphone algorithm. This method is provided in order to satisfy the requirements of the Encoder interface, and will throw an EncoderException if the supplied object is not of type java.lang.String.

Specified by:

encode in interface Encoder

Parameters:

pObject - Object to encode

Returns:

An object (or type java.lang.String) containing the caverphone code which corresponds to the String supplied.

Throws:

EncoderException - if the parameter supplied is not of type java.lang.String

encode

public String encode(String pString)

Encodes a String using the Caverphone algorithm.

Specified by:

encode in interface StringEncoder

Parameters:

pString - String object to encode

Returns:

The caverphone code corresponding to the String supplied

isCaverphoneEqual

public boolean isCaverphoneEqual(String str1,
                                 String str2)

Tests if the caverphones of two strings are identical.

Parameters:

str1 - First of two strings to compare

str2 - Second of two strings to compare

Returns:

true if the caverphones of these strings are identical, false otherwise.