← Back to branch summary

~s-friedemann/tomdroid/sshfs

« back to all changes in this revision

Viewing changes to lib/commons-codec-1.4/apidocs/org/apache/commons/codec/language/Metaphone.html

  • Committer: Benoit Garret
  • Date: 2010-03-06 20:39:56 UTC
  • mto: (185.4.1 sync-ui)
  • mto: This revision was merged to the branch mainline in revision 186.
  • Revision ID: benoit.garret_launchpad@gadz.org-20100306203956-k6vlss6hk2d91j4n
Put the signpost and commons-codec libraries in lib/

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/commons-codec-1.4/apidocs/org/apache/commons/codec/language/Metaphone.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 
2
<!--NewPage-->
 
3
<HTML>
 
4
<HEAD>
 
5
<!-- Generated by javadoc (build 1.6.0_07) on Thu Aug 06 17:42:38 BST 2009 -->
 
6
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
7
<TITLE>
 
8
Metaphone (Commons Codec 1.4 API)
 
9
</TITLE>
 
10
 
 
11
<META NAME="date" CONTENT="2009-08-06">
 
12
 
 
13
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
 
14
 
 
15
<SCRIPT type="text/javascript">
 
16
function windowTitle()
 
17
{
 
18
    if (location.href.indexOf('is-external=true') == -1) {
 
19
        parent.document.title="Metaphone (Commons Codec 1.4 API)";
 
20
    }
 
21
}
 
22
</SCRIPT>
 
23
<NOSCRIPT>
 
24
</NOSCRIPT>
 
25
 
 
26
</HEAD>
 
27
 
 
28
<BODY BGCOLOR="white" onload="windowTitle();">
 
29
<HR>
 
30
 
 
31
 
 
32
<!-- ========= START OF TOP NAVBAR ======= -->
 
33
<A NAME="navbar_top"><!-- --></A>
 
34
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 
35
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 
36
<TR>
 
37
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
38
<A NAME="navbar_top_firstrow"><!-- --></A>
 
39
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 
40
  <TR ALIGN="center" VALIGN="top">
 
41
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
42
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
43
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
44
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Metaphone.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 
45
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
46
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
47
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
48
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
49
  </TR>
 
50
</TABLE>
 
51
</TD>
 
52
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
53
</EM>
 
54
</TD>
 
55
</TR>
 
56
 
 
57
<TR>
 
58
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
59
&nbsp;<A HREF="../../../../../org/apache/commons/codec/language/DoubleMetaphone.DoubleMetaphoneResult.html" title="class in org.apache.commons.codec.language"><B>PREV CLASS</B></A>&nbsp;
 
60
&nbsp;<A HREF="../../../../../org/apache/commons/codec/language/RefinedSoundex.html" title="class in org.apache.commons.codec.language"><B>NEXT CLASS</B></A></FONT></TD>
 
61
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
62
  <A HREF="../../../../../index.html?org/apache/commons/codec/language/Metaphone.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 
63
&nbsp;<A HREF="Metaphone.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 
64
&nbsp;<SCRIPT type="text/javascript">
 
65
  <!--
 
66
  if(window==top) {
 
67
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 
68
  }
 
69
  //-->
 
70
</SCRIPT>
 
71
<NOSCRIPT>
 
72
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 
73
</NOSCRIPT>
 
74
 
 
75
 
 
76
</FONT></TD>
 
77
</TR>
 
78
<TR>
 
79
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
80
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
81
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
82
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
83
</TR>
 
84
</TABLE>
 
85
<A NAME="skip-navbar_top"></A>
 
86
<!-- ========= END OF TOP NAVBAR ========= -->
 
87
 
 
88
<HR>
 
89
<!-- ======== START OF CLASS DATA ======== -->
 
90
<H2>
 
91
<FONT SIZE="-1">
 
92
org.apache.commons.codec.language</FONT>
 
93
<BR>
 
94
Class Metaphone</H2>
 
95
<PRE>
 
96
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
 
97
  <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.codec.language.Metaphone</B>
 
98
</PRE>
 
99
<DL>
 
100
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/commons/codec/Encoder.html" title="interface in org.apache.commons.codec">Encoder</A>, <A HREF="../../../../../org/apache/commons/codec/StringEncoder.html" title="interface in org.apache.commons.codec">StringEncoder</A></DD>
 
101
</DL>
 
102
<HR>
 
103
<DL>
 
104
<DT><PRE>public class <A HREF="../../../../../src-html/org/apache/commons/codec/language/Metaphone.html#line.43"><B>Metaphone</B></A><DT>extends <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../org/apache/commons/codec/StringEncoder.html" title="interface in org.apache.commons.codec">StringEncoder</A></DL>
 
105
</PRE>
 
106
 
 
107
<P>
 
108
Encodes a string into a metaphone value. 
 
109
 <p>
 
110
 Initial Java implementation by <CITE>William B. Brogden. December, 1997</CITE>. 
 
111
 Permission given by <CITE>wbrogden</CITE> for code to be used anywhere.
 
112
 </p>
 
113
 <p>
 
114
 <CITE>Hanging on the Metaphone</CITE> by <CITE>Lawrence Philips</CITE> in <CITE>Computer Language of Dec. 1990, p
 
115
 39.</CITE>
 
116
 </p>
 
117
 <p>
 
118
 Note, that this does not match the algorithm that ships with PHP, or the algorithm 
 
119
 found in the Perl <a href="http://search.cpan.org/~mschwern/Text-Metaphone-1.96/Metaphone.pm">Text:Metaphone-1.96</a>.
 
120
 They have had undocumented changes from the originally published algorithm. 
 
121
 For more information, see <a href="https://issues.apache.org/jira/browse/CODEC-57">CODEC-57</a>.
 
122
 </p>
 
123
<P>
 
124
 
 
125
<P>
 
126
<DL>
 
127
<DT><B>Version:</B></DT>
 
128
  <DD>$Id: Metaphone.java 797690 2009-07-24 23:28:35Z ggregory $</DD>
 
129
<DT><B>Author:</B></DT>
 
130
  <DD>Apache Software Foundation</DD>
 
131
</DL>
 
132
<HR>
 
133
 
 
134
<P>
 
135
 
 
136
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
 
137
 
 
138
<A NAME="constructor_summary"><!-- --></A>
 
139
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
140
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
141
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 
142
<B>Constructor Summary</B></FONT></TH>
 
143
</TR>
 
144
<TR BGCOLOR="white" CLASS="TableRowColor">
 
145
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/language/Metaphone.html#Metaphone()">Metaphone</A></B>()</CODE>
 
146
 
 
147
<BR>
 
148
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an instance of the Metaphone encoder</TD>
 
149
</TR>
 
150
</TABLE>
 
151
&nbsp;
 
152
<!-- ========== METHOD SUMMARY =========== -->
 
153
 
 
154
<A NAME="method_summary"><!-- --></A>
 
155
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
156
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
157
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 
158
<B>Method Summary</B></FONT></TH>
 
159
</TR>
 
160
<TR BGCOLOR="white" CLASS="TableRowColor">
 
161
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
162
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD>
 
163
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/language/Metaphone.html#encode(java.lang.Object)">encode</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;pObject)</CODE>
 
164
 
 
165
<BR>
 
166
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Encodes an Object using the metaphone algorithm.</TD>
 
167
</TR>
 
168
<TR BGCOLOR="white" CLASS="TableRowColor">
 
169
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
170
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
 
171
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/language/Metaphone.html#encode(java.lang.String)">encode</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;pString)</CODE>
 
172
 
 
173
<BR>
 
174
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Encodes a String using the Metaphone algorithm.</TD>
 
175
</TR>
 
176
<TR BGCOLOR="white" CLASS="TableRowColor">
 
177
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
178
<CODE>&nbsp;int</CODE></FONT></TD>
 
179
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/language/Metaphone.html#getMaxCodeLen()">getMaxCodeLen</A></B>()</CODE>
 
180
 
 
181
<BR>
 
182
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the maxCodeLen.</TD>
 
183
</TR>
 
184
<TR BGCOLOR="white" CLASS="TableRowColor">
 
185
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
186
<CODE>&nbsp;boolean</CODE></FONT></TD>
 
187
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/language/Metaphone.html#isMetaphoneEqual(java.lang.String, java.lang.String)">isMetaphoneEqual</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;str1,
 
188
                                 <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;str2)</CODE>
 
189
 
 
190
<BR>
 
191
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests is the metaphones of two strings are identical.</TD>
 
192
</TR>
 
193
<TR BGCOLOR="white" CLASS="TableRowColor">
 
194
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
195
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
 
196
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/language/Metaphone.html#metaphone(java.lang.String)">metaphone</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;txt)</CODE>
 
197
 
 
198
<BR>
 
199
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Find the metaphone value of a String.</TD>
 
200
</TR>
 
201
<TR BGCOLOR="white" CLASS="TableRowColor">
 
202
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
203
<CODE>&nbsp;void</CODE></FONT></TD>
 
204
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/language/Metaphone.html#setMaxCodeLen(int)">setMaxCodeLen</A></B>(int&nbsp;maxCodeLen)</CODE>
 
205
 
 
206
<BR>
 
207
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the maxCodeLen.</TD>
 
208
</TR>
 
209
</TABLE>
 
210
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 
211
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
212
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 
213
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
 
214
</TR>
 
215
<TR BGCOLOR="white" CLASS="TableRowColor">
 
216
<TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
 
217
</TR>
 
218
</TABLE>
 
219
&nbsp;
 
220
<P>
 
221
 
 
222
<!-- ========= CONSTRUCTOR DETAIL ======== -->
 
223
 
 
224
<A NAME="constructor_detail"><!-- --></A>
 
225
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
226
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
227
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 
228
<B>Constructor Detail</B></FONT></TH>
 
229
</TR>
 
230
</TABLE>
 
231
 
 
232
<A NAME="Metaphone()"><!-- --></A><H3>
 
233
Metaphone</H3>
 
234
<PRE>
 
235
public <A HREF="../../../../../src-html/org/apache/commons/codec/language/Metaphone.html#line.68"><B>Metaphone</B></A>()</PRE>
 
236
<DL>
 
237
<DD>Creates an instance of the Metaphone encoder
 
238
<P>
 
239
</DL>
 
240
 
 
241
<!-- ============ METHOD DETAIL ========== -->
 
242
 
 
243
<A NAME="method_detail"><!-- --></A>
 
244
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
245
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
246
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 
247
<B>Method Detail</B></FONT></TH>
 
248
</TR>
 
249
</TABLE>
 
250
 
 
251
<A NAME="metaphone(java.lang.String)"><!-- --></A><H3>
 
252
metaphone</H3>
 
253
<PRE>
 
254
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../src-html/org/apache/commons/codec/language/Metaphone.html#line.82"><B>metaphone</B></A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;txt)</PRE>
 
255
<DL>
 
256
<DD>Find the metaphone value of a String. This is similar to the
 
257
 soundex algorithm, but better at finding similar sounding words.
 
258
 All input is converted to upper case.
 
259
 Limitations: Input format is expected to be a single ASCII word
 
260
 with only characters in the A - Z range, no punctuation or numbers.
 
261
<P>
 
262
<DD><DL>
 
263
</DL>
 
264
</DD>
 
265
<DD><DL>
 
266
<DT><B>Parameters:</B><DD><CODE>txt</CODE> - String to find the metaphone code for
 
267
<DT><B>Returns:</B><DD>A metaphone code corresponding to the String supplied</DL>
 
268
</DD>
 
269
</DL>
 
270
<HR>
 
271
 
 
272
<A NAME="encode(java.lang.Object)"><!-- --></A><H3>
 
273
encode</H3>
 
274
<PRE>
 
275
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <A HREF="../../../../../src-html/org/apache/commons/codec/language/Metaphone.html#line.366"><B>encode</B></A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;pObject)
 
276
              throws <A HREF="../../../../../org/apache/commons/codec/EncoderException.html" title="class in org.apache.commons.codec">EncoderException</A></PRE>
 
277
<DL>
 
278
<DD>Encodes an Object using the metaphone algorithm.  This method
 
279
 is provided in order to satisfy the requirements of the
 
280
 Encoder interface, and will throw an EncoderException if the
 
281
 supplied object is not of type java.lang.String.
 
282
<P>
 
283
<DD><DL>
 
284
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/codec/Encoder.html#encode(java.lang.Object)">encode</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/codec/Encoder.html" title="interface in org.apache.commons.codec">Encoder</A></CODE></DL>
 
285
</DD>
 
286
<DD><DL>
 
287
<DT><B>Parameters:</B><DD><CODE>pObject</CODE> - Object to encode
 
288
<DT><B>Returns:</B><DD>An object (or type java.lang.String) containing the 
 
289
         metaphone code which corresponds to the String supplied.
 
290
<DT><B>Throws:</B>
 
291
<DD><CODE><A HREF="../../../../../org/apache/commons/codec/EncoderException.html" title="class in org.apache.commons.codec">EncoderException</A></CODE> - if the parameter supplied is not
 
292
                          of type java.lang.String</DL>
 
293
</DD>
 
294
</DL>
 
295
<HR>
 
296
 
 
297
<A NAME="encode(java.lang.String)"><!-- --></A><H3>
 
298
encode</H3>
 
299
<PRE>
 
300
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../src-html/org/apache/commons/codec/language/Metaphone.html#line.379"><B>encode</B></A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;pString)</PRE>
 
301
<DL>
 
302
<DD>Encodes a String using the Metaphone algorithm.
 
303
<P>
 
304
<DD><DL>
 
305
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/codec/StringEncoder.html#encode(java.lang.String)">encode</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/codec/StringEncoder.html" title="interface in org.apache.commons.codec">StringEncoder</A></CODE></DL>
 
306
</DD>
 
307
<DD><DL>
 
308
<DT><B>Parameters:</B><DD><CODE>pString</CODE> - String object to encode
 
309
<DT><B>Returns:</B><DD>The metaphone code corresponding to the String supplied</DL>
 
310
</DD>
 
311
</DL>
 
312
<HR>
 
313
 
 
314
<A NAME="isMetaphoneEqual(java.lang.String, java.lang.String)"><!-- --></A><H3>
 
315
isMetaphoneEqual</H3>
 
316
<PRE>
 
317
public boolean <A HREF="../../../../../src-html/org/apache/commons/codec/language/Metaphone.html#line.391"><B>isMetaphoneEqual</B></A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;str1,
 
318
                                <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;str2)</PRE>
 
319
<DL>
 
320
<DD>Tests is the metaphones of two strings are identical.
 
321
<P>
 
322
<DD><DL>
 
323
</DL>
 
324
</DD>
 
325
<DD><DL>
 
326
<DT><B>Parameters:</B><DD><CODE>str1</CODE> - First of two strings to compare<DD><CODE>str2</CODE> - Second of two strings to compare
 
327
<DT><B>Returns:</B><DD><code>true</code> if the metaphones of these strings are identical, 
 
328
        <code>false</code> otherwise.</DL>
 
329
</DD>
 
330
</DL>
 
331
<HR>
 
332
 
 
333
<A NAME="getMaxCodeLen()"><!-- --></A><H3>
 
334
getMaxCodeLen</H3>
 
335
<PRE>
 
336
public int <A HREF="../../../../../src-html/org/apache/commons/codec/language/Metaphone.html#line.399"><B>getMaxCodeLen</B></A>()</PRE>
 
337
<DL>
 
338
<DD>Returns the maxCodeLen.
 
339
<P>
 
340
<DD><DL>
 
341
</DL>
 
342
</DD>
 
343
<DD><DL>
 
344
 
 
345
<DT><B>Returns:</B><DD>int</DL>
 
346
</DD>
 
347
</DL>
 
348
<HR>
 
349
 
 
350
<A NAME="setMaxCodeLen(int)"><!-- --></A><H3>
 
351
setMaxCodeLen</H3>
 
352
<PRE>
 
353
public void <A HREF="../../../../../src-html/org/apache/commons/codec/language/Metaphone.html#line.405"><B>setMaxCodeLen</B></A>(int&nbsp;maxCodeLen)</PRE>
 
354
<DL>
 
355
<DD>Sets the maxCodeLen.
 
356
<P>
 
357
<DD><DL>
 
358
</DL>
 
359
</DD>
 
360
<DD><DL>
 
361
<DT><B>Parameters:</B><DD><CODE>maxCodeLen</CODE> - The maxCodeLen to set</DL>
 
362
</DD>
 
363
</DL>
 
364
<!-- ========= END OF CLASS DATA ========= -->
 
365
<HR>
 
366
 
 
367
 
 
368
<!-- ======= START OF BOTTOM NAVBAR ====== -->
 
369
<A NAME="navbar_bottom"><!-- --></A>
 
370
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 
371
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 
372
<TR>
 
373
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
374
<A NAME="navbar_bottom_firstrow"><!-- --></A>
 
375
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 
376
  <TR ALIGN="center" VALIGN="top">
 
377
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
378
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
379
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
380
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Metaphone.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 
381
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
382
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
383
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
384
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
385
  </TR>
 
386
</TABLE>
 
387
</TD>
 
388
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
389
</EM>
 
390
</TD>
 
391
</TR>
 
392
 
 
393
<TR>
 
394
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
395
&nbsp;<A HREF="../../../../../org/apache/commons/codec/language/DoubleMetaphone.DoubleMetaphoneResult.html" title="class in org.apache.commons.codec.language"><B>PREV CLASS</B></A>&nbsp;
 
396
&nbsp;<A HREF="../../../../../org/apache/commons/codec/language/RefinedSoundex.html" title="class in org.apache.commons.codec.language"><B>NEXT CLASS</B></A></FONT></TD>
 
397
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
398
  <A HREF="../../../../../index.html?org/apache/commons/codec/language/Metaphone.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 
399
&nbsp;<A HREF="Metaphone.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 
400
&nbsp;<SCRIPT type="text/javascript">
 
401
  <!--
 
402
  if(window==top) {
 
403
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 
404
  }
 
405
  //-->
 
406
</SCRIPT>
 
407
<NOSCRIPT>
 
408
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 
409
</NOSCRIPT>
 
410
 
 
411
 
 
412
</FONT></TD>
 
413
</TR>
 
414
<TR>
 
415
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
416
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
417
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
418
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
419
</TR>
 
420
</TABLE>
 
421
<A NAME="skip-navbar_bottom"></A>
 
422
<!-- ======== END OF BOTTOM NAVBAR ======= -->
 
423
 
 
424
<HR>
 
425
Copyright &#169; 2002-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
 
426
</BODY>
 
427
</HTML>