/usr/share/doc/libjazzy-java/javadoc/com/swabunga/spell/engine/SpellDictionary.html is in libjazzy-java 0.5.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Mon Oct 17 20:17:59 UTC 2011 -->
<TITLE>
SpellDictionary
</TITLE>
<META NAME="date" CONTENT="2011-10-17">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SpellDictionary";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../com/swabunga/spell/engine/PropertyConfiguration.html" title="class in com.swabunga.spell.engine"><B>PREV CLASS</B></A>
<A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryASpell.html" title="class in com.swabunga.spell.engine"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/swabunga/spell/engine/SpellDictionary.html" target="_top"><B>FRAMES</B></A>
<A HREF="SpellDictionary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.swabunga.spell.engine</FONT>
<BR>
Interface SpellDictionary</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/swabunga/spell/engine/GenericSpellDictionary.html" title="class in com.swabunga.spell.engine">GenericSpellDictionary</A>, <A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryASpell.html" title="class in com.swabunga.spell.engine">SpellDictionaryASpell</A>, <A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryCachedDichoDisk.html" title="class in com.swabunga.spell.engine">SpellDictionaryCachedDichoDisk</A>, <A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryDichoDisk.html" title="class in com.swabunga.spell.engine">SpellDictionaryDichoDisk</A>, <A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryDisk.html" title="class in com.swabunga.spell.engine">SpellDictionaryDisk</A>, <A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryHashMap.html" title="class in com.swabunga.spell.engine">SpellDictionaryHashMap</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>SpellDictionary</B></DL>
</PRE>
<P>
An interface for all dictionary implementations. It defines the most basic
operations on a dictionary: adding words, checking if a word is correct, and getting a list
of suggestions for misspelled words.
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionary.html#addWord(java.lang.String)">addWord</A></B>(java.lang.String word)</CODE>
<BR>
Add a word permanently to the dictionary.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.List</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionary.html#getSuggestions(java.lang.String, int)">getSuggestions</A></B>(java.lang.String sourceWord,
int scoreThreshold)</CODE>
<BR>
Returns a list of Word objects that are the suggestions to any word.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.List</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionary.html#getSuggestions(java.lang.String, int, int[][])">getSuggestions</A></B>(java.lang.String sourceWord,
int scoreThreshold,
int[][] matrix)</CODE>
<BR>
Returns a list of Word objects that are the suggestions to any word.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/swabunga/spell/engine/SpellDictionary.html#isCorrect(java.lang.String)">isCorrect</A></B>(java.lang.String word)</CODE>
<BR>
Evaluates if the word is correctly spelled against the dictionary.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="addWord(java.lang.String)"><!-- --></A><H3>
addWord</H3>
<PRE>
void <B>addWord</B>(java.lang.String word)</PRE>
<DL>
<DD>Add a word permanently to the dictionary.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>word</CODE> - The word to add to the dictionary</DL>
</DD>
</DL>
<HR>
<A NAME="isCorrect(java.lang.String)"><!-- --></A><H3>
isCorrect</H3>
<PRE>
boolean <B>isCorrect</B>(java.lang.String word)</PRE>
<DL>
<DD>Evaluates if the word is correctly spelled against the dictionary.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>word</CODE> - The word to verify if it's spelling is OK.
<DT><B>Returns:</B><DD>Indicates if the word is present in the dictionary.</DL>
</DD>
</DL>
<HR>
<A NAME="getSuggestions(java.lang.String, int)"><!-- --></A><H3>
getSuggestions</H3>
<PRE>
java.util.List <B>getSuggestions</B>(java.lang.String sourceWord,
int scoreThreshold)</PRE>
<DL>
<DD>Returns a list of Word objects that are the suggestions to any word.
If the word is correctly spelled, then this method
could return just that one word, or it could still return a list
of words with similar spellings.
<br/>
Each suggested word has a score, which is an integer
that represents how different the suggested word is from the sourceWord.
If the words are the exactly the same, then the score is 0.
You can get the dictionary to only return the most similar words by setting
an appropriately low threshold value.
If you set the threshold value too low, you may get no suggestions for a given word.
<p>
This method is only needed to provide backward compatibility.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sourceWord</CODE> - the string that we want to get a list of spelling suggestions for<DD><CODE>scoreThreshold</CODE> - Any words that have score less than this number are returned.
<DT><B>Returns:</B><DD>List a List of suggested words<DT><B>See Also:</B><DD><A HREF="../../../../com/swabunga/spell/engine/SpellDictionary.html#getSuggestions(java.lang.String, int, int[][])"><CODE>getSuggestions(String, int, int[][])</CODE></A>,
<A HREF="../../../../com/swabunga/spell/engine/Word.html" title="class in com.swabunga.spell.engine"><CODE>Word</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getSuggestions(java.lang.String, int, int[][])"><!-- --></A><H3>
getSuggestions</H3>
<PRE>
java.util.List <B>getSuggestions</B>(java.lang.String sourceWord,
int scoreThreshold,
int[][] matrix)</PRE>
<DL>
<DD>Returns a list of Word objects that are the suggestions to any word.
If the word is correctly spelled, then this method
could return just that one word, or it could still return a list
of words with similar spellings.
<br/>
Each suggested word has a score, which is an integer
that represents how different the suggested word is from the sourceWord.
If the words are the exactly the same, then the score is 0.
You can get the dictionary to only return the most similar words by setting
an appropriately low threshold value.
If you set the threshold value too low, you may get no suggestions for a given word.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sourceWord</CODE> - the string that we want to get a list of spelling suggestions for<DD><CODE>scoreThreshold</CODE> - Any words that have score less than this number are returned.<DD><CODE>Two</CODE> - dimensional int array used to calculate edit distance. Allocating
this memory outside of the function will greatly improve efficiency.
<DT><B>Returns:</B><DD>List a List of suggested words<DT><B>See Also:</B><DD><A HREF="../../../../com/swabunga/spell/engine/Word.html" title="class in com.swabunga.spell.engine"><CODE>Word</CODE></A></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../com/swabunga/spell/engine/PropertyConfiguration.html" title="class in com.swabunga.spell.engine"><B>PREV CLASS</B></A>
<A HREF="../../../../com/swabunga/spell/engine/SpellDictionaryASpell.html" title="class in com.swabunga.spell.engine"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/swabunga/spell/engine/SpellDictionary.html" target="_top"><B>FRAMES</B></A>
<A HREF="SpellDictionary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|