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.5.0_04) on Sun Feb 19 05:15:30 PST 2006 --> 6<TITLE> 7USPostalCodeService.MatchOptions (JPostal API) 8</TITLE> 9 10<META NAME="keywords" CONTENT="org.ahmadsoft.postal.USPostalCodeService.MatchOptions class"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="/stylesheet.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 parent.document.title="USPostalCodeService.MatchOptions (JPostal API)"; 18} 19</SCRIPT> 20<NOSCRIPT> 21</NOSCRIPT> 22 23</HEAD> 24 25<BODY BGCOLOR="white" onload="windowTitle();"> 26 27 28<!-- ========= START OF TOP NAVBAR ======= --> 29<A NAME="navbar_top"><!-- --></A> 30<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 32<TR> 33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 34<A NAME="navbar_top_firstrow"><!-- --></A> 35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 36 <TR ALIGN="center" VALIGN="top"> 37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/org/ahmadsoft/postal/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 38 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/USPostalCodeService.MatchOptions.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 44 </TR> 45</TABLE> 46</TD> 47<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 48</EM> 49</TD> 50</TR> 51 52<TR> 53<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 54 <A HREF="/org/ahmadsoft/postal/USPostalCodeService.html" title="class in org.ahmadsoft.postal"><B>PREV CLASS</B></A> 55 <A HREF="/org/ahmadsoft/postal/USPostalCodeService.MatchResult.html" title="class in org.ahmadsoft.postal"><B>NEXT CLASS</B></A></FONT></TD> 56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 57 <A HREF="/index.html?org/ahmadsoft/postal/USPostalCodeService.MatchOptions.html" target="_top"><B>FRAMES</B></A> 58 <A HREF="USPostalCodeService.MatchOptions.html" target="_top"><B>NO FRAMES</B></A> 59 <SCRIPT type="text/javascript"> 60 <!-- 61 if(window==top) { 62 document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>'); 63 } 64 //--> 65</SCRIPT> 66<NOSCRIPT> 67 <A HREF="/allclasses-noframe.html"><B>All Classes</B></A> 68</NOSCRIPT> 69 70 71</FONT></TD> 72</TR> 73<TR> 74<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 75 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 76<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 77DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 78</TR> 79</TABLE> 80<A NAME="skip-navbar_top"></A> 81<!-- ========= END OF TOP NAVBAR ========= --> 82 83<HR> 84<!-- ======== START OF CLASS DATA ======== --> 85<H2> 86<FONT SIZE="-1"> 87org.ahmadsoft.postal</FONT> 88<BR> 89Class USPostalCodeService.MatchOptions</H2> 90<PRE> 91java.lang.Object 92 <IMG SRC="/resources/inherit.gif" ALT="extended by "><B>org.ahmadsoft.postal.USPostalCodeService.MatchOptions</B> 93</PRE> 94<DL> 95<DT><B>Enclosing class:</B><DD><A HREF="/org/ahmadsoft/postal/USPostalCodeService.html" title="class in org.ahmadsoft.postal">USPostalCodeService</A></DD> 96</DL> 97<HR> 98<DL> 99<DT><PRE>public static class <B>USPostalCodeService.MatchOptions</B><DT>extends java.lang.Object</DL> 100</PRE> 101 102<P> 103Specifies options for performing an advanced match 104 operation. 105<P> 106 107<P> 108<DL> 109<DT><B>Author:</B></DT> 110 <DD>Amin Ahmad</DD> 111</DL> 112<HR> 113 114<P> 115 116<!-- ======== CONSTRUCTOR SUMMARY ======== --> 117 118<A NAME="constructor_summary"><!-- --></A> 119<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 120<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 121<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 122<B>Constructor Summary</B></FONT></TH> 123</TR> 124<TR BGCOLOR="white" CLASS="TableRowColor"> 125<TD><CODE><B><A HREF="/org/ahmadsoft/postal/USPostalCodeService.MatchOptions.html#USPostalCodeService.MatchOptions(boolean, boolean, boolean, int)">USPostalCodeService.MatchOptions</A></B>(boolean ignoreCapitalization, 126 boolean ignorePunctuation, 127 boolean ignoreWhitespace, 128 int maxMatchLevel)</CODE> 129 130<BR> 131 Creates a new match option.</TD> 132</TR> 133</TABLE> 134 135<!-- ========== METHOD SUMMARY =========== --> 136 137<A NAME="method_summary"><!-- --></A> 138<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 139<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 140<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 141<B>Method Summary</B></FONT></TH> 142</TR> 143<TR BGCOLOR="white" CLASS="TableRowColor"> 144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 145<CODE> int</CODE></FONT></TD> 146<TD><CODE><B><A HREF="/org/ahmadsoft/postal/USPostalCodeService.MatchOptions.html#getMaxMatchLevel()">getMaxMatchLevel</A></B>()</CODE> 147 148<BR> 149 Returns the maximum match level for a match operation.</TD> 150</TR> 151<TR BGCOLOR="white" CLASS="TableRowColor"> 152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 153<CODE> boolean</CODE></FONT></TD> 154<TD><CODE><B><A HREF="/org/ahmadsoft/postal/USPostalCodeService.MatchOptions.html#isIgnoreCapitalization()">isIgnoreCapitalization</A></B>()</CODE> 155 156<BR> 157 Returns <code>true</code> is capitalization should be ignored when computing 158 the distance between two names, and <code>false</code> otherwise.</TD> 159</TR> 160<TR BGCOLOR="white" CLASS="TableRowColor"> 161<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 162<CODE> boolean</CODE></FONT></TD> 163<TD><CODE><B><A HREF="/org/ahmadsoft/postal/USPostalCodeService.MatchOptions.html#isIgnorePunctuation()">isIgnorePunctuation</A></B>()</CODE> 164 165<BR> 166 Returns <code>true</code> if punctuation should be ignored when computing the 167 distance between two names, and <code>false</code> otherwise.</TD> 168</TR> 169<TR BGCOLOR="white" CLASS="TableRowColor"> 170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 171<CODE> boolean</CODE></FONT></TD> 172<TD><CODE><B><A HREF="/org/ahmadsoft/postal/USPostalCodeService.MatchOptions.html#isIgnoreWhitespace()">isIgnoreWhitespace</A></B>()</CODE> 173 174<BR> 175 Returns <code>true</code> if whitespace should be ignored when computing the 176 distance between two names, and <code>false otherwise</code>.</TD> 177</TR> 178</TABLE> 179 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 180<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 181<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 182<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> 183</TR> 184<TR BGCOLOR="white" CLASS="TableRowColor"> 185<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> 186</TR> 187</TABLE> 188 189<P> 190 191<!-- ========= CONSTRUCTOR DETAIL ======== --> 192 193<A NAME="constructor_detail"><!-- --></A> 194<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 195<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 196<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 197<B>Constructor Detail</B></FONT></TH> 198</TR> 199</TABLE> 200 201<A NAME="USPostalCodeService.MatchOptions(boolean, boolean, boolean, int)"><!-- --></A><H3> 202USPostalCodeService.MatchOptions</H3> 203<PRE> 204public <B>USPostalCodeService.MatchOptions</B>(boolean ignoreCapitalization, 205 boolean ignorePunctuation, 206 boolean ignoreWhitespace, 207 int maxMatchLevel)</PRE> 208<DL> 209<DD>Creates a new match option. 210<P> 211<DL> 212<DT><B>Parameters:</B><DD><CODE>ignoreCapitalization</CODE> - <DD><CODE>ignorePunctuation</CODE> - <DD><CODE>ignoreWhitespace</CODE> - <DD><CODE>maxMatchLevel</CODE> - </DL> 213</DL> 214 215<!-- ============ METHOD DETAIL ========== --> 216 217<A NAME="method_detail"><!-- --></A> 218<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 219<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 220<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 221<B>Method Detail</B></FONT></TH> 222</TR> 223</TABLE> 224 225<A NAME="isIgnoreCapitalization()"><!-- --></A><H3> 226isIgnoreCapitalization</H3> 227<PRE> 228public boolean <B>isIgnoreCapitalization</B>()</PRE> 229<DL> 230<DD>Returns <code>true</code> is capitalization should be ignored when computing 231 the distance between two names, and <code>false</code> otherwise. For example, 232 if the value were true, then the distace between Dallas and dallas would be 233 zero, but if the value were false, then the distace would be one. 234<P> 235<DD><DL> 236 237<DT><B>Returns:</B><DD><code>true</code> is capitalization should be ignored when computing 238 the distance between two names, and <code>false</code> otherwise.</DL> 239</DD> 240</DL> 241<HR> 242 243<A NAME="isIgnorePunctuation()"><!-- --></A><H3> 244isIgnorePunctuation</H3> 245<PRE> 246public boolean <B>isIgnorePunctuation</B>()</PRE> 247<DL> 248<DD>Returns <code>true</code> if punctuation should be ignored when computing the 249 distance between two names, and <code>false</code> otherwise. The 250 punctuation characters are defined as follows: 251 <code>`~!@#$%^&*()_-+=[{]}\|;:'",<.>/?</code> 252<P> 253<DD><DL> 254 255<DT><B>Returns:</B><DD><code>true</code> if punctuation should be ignored when 256 computing the distance between two names, and <code>false</code> 257 otherwise.</DL> 258</DD> 259</DL> 260<HR> 261 262<A NAME="isIgnoreWhitespace()"><!-- --></A><H3> 263isIgnoreWhitespace</H3> 264<PRE> 265public boolean <B>isIgnoreWhitespace</B>()</PRE> 266<DL> 267<DD>Returns <code>true</code> if whitespace should be ignored when computing the 268 distance between two names, and <code>false otherwise</code>. If, for 269 example, the value were true, then the match distance between 270 LOSANGELES and LOS ANGELES would be one, and if the value were false, 271 the distance would be zero. 272<P> 273<DD><DL> 274 275<DT><B>Returns:</B><DD><code>true</code> if whitespace should be ignored when computing the 276 distance between two names, and <code>false otherwise</code>.</DL> 277</DD> 278</DL> 279<HR> 280 281<A NAME="getMaxMatchLevel()"><!-- --></A><H3> 282getMaxMatchLevel</H3> 283<PRE> 284public int <B>getMaxMatchLevel</B>()</PRE> 285<DL> 286<DD>Returns the maximum match level for a match operation. Only cities within a postal 287 code that meet the maximum match level are considered for inclusion in the results. 288 Note that <code>CITY_ACTUAL</code> < <code>CITY_ACCEPTABLE</code> < 289 <code>CITY_UNACCEPTABLE</code>. 290<P> 291<DD><DL> 292 293<DT><B>Returns:</B><DD>the minimum match level for a match operation.</DL> 294</DD> 295</DL> 296<!-- ========= END OF CLASS DATA ========= --> 297<HR> 298 299 300<!-- ======= START OF BOTTOM NAVBAR ====== --> 301<A NAME="navbar_bottom"><!-- --></A> 302<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 303<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 304<TR> 305<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 306<A NAME="navbar_bottom_firstrow"><!-- --></A> 307<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 308 <TR ALIGN="center" VALIGN="top"> 309 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/org/ahmadsoft/postal/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 310 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 311 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/USPostalCodeService.MatchOptions.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 312 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 313 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 314 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 315 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 316 </TR> 317</TABLE> 318</TD> 319<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 320</EM> 321</TD> 322</TR> 323 324<TR> 325<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 326 <A HREF="/org/ahmadsoft/postal/USPostalCodeService.html" title="class in org.ahmadsoft.postal"><B>PREV CLASS</B></A> 327 <A HREF="/org/ahmadsoft/postal/USPostalCodeService.MatchResult.html" title="class in org.ahmadsoft.postal"><B>NEXT CLASS</B></A></FONT></TD> 328<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 329 <A HREF="/index.html?org/ahmadsoft/postal/USPostalCodeService.MatchOptions.html" target="_top"><B>FRAMES</B></A> 330 <A HREF="USPostalCodeService.MatchOptions.html" target="_top"><B>NO FRAMES</B></A> 331 <SCRIPT type="text/javascript"> 332 <!-- 333 if(window==top) { 334 document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>'); 335 } 336 //--> 337</SCRIPT> 338<NOSCRIPT> 339 <A HREF="/allclasses-noframe.html"><B>All Classes</B></A> 340</NOSCRIPT> 341 342 343</FONT></TD> 344</TR> 345<TR> 346<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 347 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 348<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 349DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 350</TR> 351</TABLE> 352<A NAME="skip-navbar_bottom"></A> 353<!-- ======== END OF BOTTOM NAVBAR ======= --> 354 355<HR> 356<i>Copyright © 2006 Ahmadsoft. All Rights Reserved.</i> 357</BODY> 358</HTML> 359
