org.axiondb.functions
Class SoundexFunction

java.lang.Object
  org.axiondb.BaseSelectable
      org.axiondb.functions.BaseFunction
          org.axiondb.functions.SoundexFunction

All Implemented Interfaces:

java.io.Serializable, Function, FunctionFactory, ConcreteFunction, ScalarFunction, Selectable

Direct Known Subclasses:

DifferenceFunction, SoundsLikeFunction

public class SoundexFunction
extends BaseFunction
implements ScalarFunction, FunctionFactory

Version:

$Revision: 1.4 $ $Date: 2005/03/03 02:22:00 $

See Also:

Serialized Form

Field Summary

Fields inherited from class org.axiondb.BaseSelectable

_hash

Constructor Summary

SoundexFunction()
Creates a new instance of Class

SoundexFunction(java.lang.String name)
Creates a new instance of Class

Method Summary

java.lang.Object	evaluate(RowDecorator row)
DataType	getDataType() StringType
boolean	isValid()
ConcreteFunction	makeNewInstance()
static java.lang.String	soundex(java.lang.String s) Returns a four character code representing the sound of the given String.

Methods inherited from class org.axiondb.functions.BaseFunction

addArgument, getArgument, getArgumentCount, setArgument, setVariableContext, toString

Methods inherited from class org.axiondb.BaseSelectable

getAlias, getLabel, getName, setAlias, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axiondb.Function

addArgument, getAlias, getArgument, getArgumentCount, getName, setAlias, setArgument

Methods inherited from interface org.axiondb.Selectable

getLabel, setVariableContext

Constructor Detail

SoundexFunction

public SoundexFunction()

Creates a new instance of Class

SoundexFunction

public SoundexFunction(java.lang.String name)

Creates a new instance of Class

Method Detail

makeNewInstance

public ConcreteFunction makeNewInstance()

Specified by:

makeNewInstance in interface FunctionFactory

getDataType

public DataType getDataType()

StringType

Specified by:

getDataType in interface Selectable

Specified by:

getDataType in class BaseFunction

evaluate

public java.lang.Object evaluate(RowDecorator row)
                          throws AxionException

Specified by:

evaluate in interface ScalarFunction

Specified by:

evaluate in interface Selectable

Throws:

AxionException

isValid

public boolean isValid()

Specified by:

isValid in interface ConcreteFunction

Specified by:

isValid in class BaseFunction

soundex

public static java.lang.String soundex(java.lang.String s)

Returns a four character code representing the sound of the given String. Non-ASCCI characters in the input String are ignored.

This method was rewritten for Axion to comply with the description at http://www.nara.gov/genealogy/coding.html .

Parameters:

s - the String for which to calculate the 4 character SOUNDEX value

Returns:

the 4 character SOUNDEX value for the given String