de.unidu.is.text
Class CodecSoundexFilter

java.lang.Object
  de.unidu.is.text.AbstractFilter
      de.unidu.is.text.AbstractSingleItemFilter
          de.unidu.is.text.CodecSoundexFilter

All Implemented Interfaces:

Filter, SingleItemFilter

public class CodecSoundexFilter

extends AbstractSingleItemFilter

This filter converts a specified string into its soundex representation, using code from Apache Jakarta Commons Codec.

Since:

2004-12-09

Version:

$Revision: 1.4 $, $Date: 2005/03/14 17:33:14 $

Author:

Henrik Nottelmann

Field Summary

static char[]	US_ENGLISH_MAPPING This is a default mapping of the 26 letters used in US English.
static java.lang.String	US_ENGLISH_MAPPING_STRING This is a default mapping of the 26 letters used in US English.

Fields inherited from class de.unidu.is.text.AbstractFilter

nextFilter

Constructor Summary

CodecSoundexFilter(Filter nextFilter)
Creates a new instance and sets the next filter in the chain.

Method Summary

java.lang.Object

run(java.lang.Object value) Converts the specified object into its soundex value.

Methods inherited from class de.unidu.is.text.AbstractSingleItemFilter

filter

Methods inherited from class de.unidu.is.text.AbstractFilter

apply, apply

Methods inherited from class java.lang.Object

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

Field Detail

US_ENGLISH_MAPPING_STRING

public static final java.lang.String US_ENGLISH_MAPPING_STRING

This is a default mapping of the 26 letters used in US English. A value of 0 for a letter position means do not encode.

(This constant is provided as both an implementation convenience and to allow Javadoc to pick up the value for the constant values page.)

See Also:

US_ENGLISH_MAPPING, Constant Field Values

US_ENGLISH_MAPPING

public static final char[] US_ENGLISH_MAPPING

This is a default mapping of the 26 letters used in US English. A value of 0 for a letter position means do not encode.

Constructor Detail

CodecSoundexFilter

public CodecSoundexFilter(Filter nextFilter)

Creates a new instance and sets the next filter in the chain.

Parameters:

nextFilter - next filter in the filter chain

Method Detail

run

public java.lang.Object run(java.lang.Object value)

Converts the specified object into its soundex value.

Parameters:

value - string to be converted

Returns:

soundex representation of the specified value