doublemetaphone.html

java编码的一个开发包

 
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="VOWELS"><!-- --></A><H3>
VOWELS</H3>
<PRE>
private static final <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>VOWELS</B></PRE>
<DL>
<DD>"Vowels" to test for
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.commons.codec.language.DoubleMetaphone.VOWELS">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="SILENT_START"><!-- --></A><H3>
SILENT_START</H3>
<PRE>
private static final <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] <B>SILENT_START</B></PRE>
<DL>
<DD>Prefixes when present which are not pronounced
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="L_R_N_M_B_H_F_V_W_SPACE"><!-- --></A><H3>
L_R_N_M_B_H_F_V_W_SPACE</H3>
<PRE>
private static final <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] <B>L_R_N_M_B_H_F_V_W_SPACE</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>

<A NAME="ES_EP_EB_EL_EY_IB_IL_IN_IE_EI_ER"><!-- --></A><H3>
ES_EP_EB_EL_EY_IB_IL_IN_IE_EI_ER</H3>
<PRE>
private static final <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] <B>ES_EP_EB_EL_EY_IB_IL_IN_IE_EI_ER</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>

<A NAME="L_T_K_S_N_M_B_Z"><!-- --></A><H3>
L_T_K_S_N_M_B_Z</H3>
<PRE>
private static final <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] <B>L_T_K_S_N_M_B_Z</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>

<A NAME="maxCodeLen"><!-- --></A><H3>
maxCodeLen</H3>
<PRE>
protected int <B>maxCodeLen</B></PRE>
<DL>
<DD>Maximum length of an encoding, default is 4
<P>
<DL>
</DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="DoubleMetaphone()"><!-- --></A><H3>
DoubleMetaphone</H3>
<PRE>
public <B>DoubleMetaphone</B>()</PRE>
<DL>
<DD>Creates an instance of this DoubleMetaphone encoder
<P>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="doubleMetaphone(java.lang.String)"><!-- --></A><H3>
doubleMetaphone</H3>
<PRE>
public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>doubleMetaphone</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;value)</PRE>
<DL>
<DD>Encode a value with Double Metaphone
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - String to encode
<DT><B>Returns:</B><DD>an encoded string</DL>
</DD>
</DL>
<HR>

<A NAME="doubleMetaphone(java.lang.String, boolean)"><!-- --></A><H3>
doubleMetaphone</H3>
<PRE>
public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>doubleMetaphone</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;value,
                              boolean&nbsp;alternate)</PRE>
<DL>
<DD>Encode a value with Double Metaphone, optionally using the alternate
 encoding.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - String to encode<DD><CODE>alternate</CODE> - use alternate encode
<DT><B>Returns:</B><DD>an encoded string</DL>
</DD>
</DL>
<HR>

<A NAME="encode(java.lang.Object)"><!-- --></A><H3>
encode</H3>
<PRE>
public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <B>encode</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;obj)
              throws <A HREF="../../../../../org/apache/commons/codec/EncoderException.html" title="class in org.apache.commons.codec">EncoderException</A></PRE>
<DL>
<DD>Encode the value using DoubleMetaphone.  It will only work if 
 <code>obj</code> is a <code>String</code> (like <code>Metaphone</code>).
<P>
<DD><DL>
<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>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - Object to encode (should be of type String)
<DT><B>Returns:</B><DD>An encoded Object (will be of type String)
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/commons/codec/EncoderException.html" title="class in org.apache.commons.codec">EncoderException</A></CODE> - encode parameter is not of type String</DL>
</DD>
</DL>
<HR>

<A NAME="encode(java.lang.String)"><!-- --></A><H3>
encode</H3>
<PRE>
public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>encode</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;value)</PRE>
<DL>
<DD>Encode the value using DoubleMetaphone.
<P>
<DD><DL>
<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>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - String to encode
<DT><B>Returns:</B><DD>An encoded String</DL>
</DD>
</DL>
<HR>

<A NAME="isDoubleMetaphoneEqual(java.lang.String, java.lang.String)"><!-- --></A><H3>
isDoubleMetaphoneEqual</H3>
<PRE>
public boolean <B>isDoubleMetaphoneEqual</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;value1,
                                      <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;value2)</PRE>
<DL>
<DD>Check if the Double Metaphone values of two <code>String</code> values
 are equal.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>value1</CODE> - The left-hand side of the encoded <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html#equals(java.lang.Object)" title="class or interface in java.lang"><CODE>String.equals(Object)</CODE></A>.<DD><CODE>value2</CODE> - The right-hand side of the encoded <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html#equals(java.lang.Object)" title="class or interface in java.lang"><CODE>String.equals(Object)</CODE></A>.
<DT><B>Returns:</B><DD><code>true</code> if the encoded <code>String</code>s are equal;
          <code>false</code> otherwise.<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/commons/codec/language/DoubleMetaphone.html#isDoubleMetaphoneEqual(java.lang.String, java.lang.String, boolean)"><CODE>isDoubleMetaphoneEqual(String,String,boolean)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="isDoubleMetaphoneEqual(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
isDoubleMetaphoneEqual</H3>
<PRE>
public boolean <B>isDoubleMetaphoneEqual</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;value1,
                                      <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;value2,
                                      boolean&nbsp;alternate)</PRE>
<DL>
<DD>Check if the Double Metaphone values of two <code>String</code> values
 are equal, optionally using the alternate value.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>value1</CODE> - The left-hand side of the encoded <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html#equals(java.lang.Object)" title="class or interface in java.lang"><CODE>String.equals(Object)</CODE></A>.<DD><CODE>value2</CODE> - The right-hand side of the encoded <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html#equals(java.lang.Object)" title="class or interface in java.lang"><CODE>String.equals(Object)</CODE></A>.<DD><CODE>alternate</CODE> - use the alternate value if <code>true</code>.
<DT><B>Returns:</B><DD><code>true</code> if the encoded <code>String</code>s are equal;
          <code>false</code> otherwise.</DL>
</DD>
</DL>
<HR>

<A NAME="getMaxCodeLen()"><!-- --></A><H3>