source: trunk/gsdl/packages/kea/kea-3.0/doc/KEAKeyphraseExtractor.html@ 8815

Last change on this file since 8815 was 8815, checked in by mdewsnip, 19 years ago

Kea 3.0, as downloaded from http://www.nzdl.org/kea but with CSTR_abstracts_test, CSTR_abstracts_train, Chinese_test, and Chinese_train directories removed.

  • Property svn:keywords set to Author Date Id Revision
File size: 21.4 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc on Fri Mar 19 17:50:49 NZDT 2004 -->
6<TITLE>
7KEAKeyphraseExtractor
8</TITLE>
9<META NAME="keywords" CONTENT="KEAKeyphraseExtractor,KEAKeyphraseExtractor class">
10<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
11</HEAD>
12<SCRIPT>
13function asd()
14{
15parent.document.title="KEAKeyphraseExtractor";
16}
17</SCRIPT>
18<BODY BGCOLOR="white" onload="asd();">
19
20<!-- ========== START OF NAVBAR ========== -->
21<A NAME="navbar_top"><!-- --></A>
22<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
23<TR>
24<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
25<A NAME="navbar_top_firstrow"><!-- --></A>
26<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
27 <TR ALIGN="center" VALIGN="top">
28 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
29&nbsp;</TD>
30 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
31 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
32 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
33 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
34 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
35 </TR>
36</TABLE>
37</TD>
38<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
39</EM>
40</TD>
41</TR>
42
43<TR>
44<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
45&nbsp;<A HREF="KEAFilter.html"><B>PREV CLASS</B></A>&nbsp;
46&nbsp;<A HREF="KEAModelBuilder.html"><B>NEXT CLASS</B></A></FONT></TD>
47<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
48 <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A> &nbsp;
49&nbsp;<A HREF="KEAKeyphraseExtractor.html" TARGET="_top"><B>NO FRAMES</B></A> &nbsp;
50&nbsp;
51<SCRIPT>
52 <!--
53 if(window==top) {
54 document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
55 }
56 //-->
57</SCRIPT>
58<NOSCRIPT>
59<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
60</NOSCRIPT>
61</FONT></TD>
62</TR>
63<TR>
64<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
65 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
66<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
67DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
68</TR>
69</TABLE>
70<!-- =========== END OF NAVBAR =========== -->
71
72<HR>
73<!-- ======== START OF CLASS DATA ======== -->
74<H2>
75Class KEAKeyphraseExtractor</H2>
76<PRE>
77java.lang.Object
78 |
79 +--<B>KEAKeyphraseExtractor</B>
80</PRE>
81<DL>
82<DT><B>All Implemented Interfaces:</B> <DD>weka.core.OptionHandler</DD>
83</DL>
84<HR>
85<DL>
86<DT>public class <B>KEAKeyphraseExtractor</B><DT>extends java.lang.Object<DT>implements weka.core.OptionHandler</DL>
87
88<P>
89Extracts keyphrases from the documents in a given directory.
90 Assumes that the file names for the documents end with ".txt".
91 Puts extracted keyphrases into corresponding files ending with
92 ".key" (if those are not already present). Optionally an encoding
93 for the documents/keyphrases can be defined (e.g. for Chinese
94 text). Documents for which ".key" exists, are used for evaluation.
95
96 Valid options are:<p>
97
98 -l "directory name"<br>
99 Specifies name of directory.<p>
100
101 -m "model name"<br>
102 Specifies name of model.<p>
103
104 -e "encoding"<br>
105 Specifies encoding.<p>
106
107 -n <br>
108 Specifies number of phrases to be output (default: 5).<p>
109
110 -d<br>
111 Turns debugging mode on.<p>
112
113 -a<br>
114 Also write stemmed phrase and score into ".key" file.<p>
115<P>
116
117<P>
118<HR>
119
120<P>
121<!-- ======== NESTED CLASS SUMMARY ======== -->
122
123
124<!-- =========== FIELD SUMMARY =========== -->
125
126
127<!-- ======== CONSTRUCTOR SUMMARY ======== -->
128
129<A NAME="constructor_summary"><!-- --></A>
130<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
131<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
132<TD COLSPAN=2><FONT SIZE="+2">
133<B>Constructor Summary</B></FONT></TD>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#KEAKeyphraseExtractor()">KEAKeyphraseExtractor</A></B>()</CODE>
137
138<BR>
139&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
140</TR>
141</TABLE>
142&nbsp;
143<!-- ========== METHOD SUMMARY =========== -->
144
145<A NAME="method_summary"><!-- --></A>
146<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
147<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
148<TD COLSPAN=2><FONT SIZE="+2">
149<B>Method Summary</B></FONT></TD>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153<CODE>&nbsp;java.util.Hashtable</CODE></FONT></TD>
154<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#collectStems()">collectStems</A></B>()</CODE>
155
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Collects the stems of the file names.</TD>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161<CODE>&nbsp;void</CODE></FONT></TD>
162<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#extractKeyphrases(java.util.Hashtable)">extractKeyphrases</A></B>(java.util.Hashtable&nbsp;stems)</CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Builds the model from the files</TD>
166</TR>
167<TR BGCOLOR="white" CLASS="TableRowColor">
168<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169<CODE>&nbsp;boolean</CODE></FONT></TD>
170<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#getAdditionalInfo()">getAdditionalInfo</A></B>()</CODE>
171
172<BR>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of AdditionalInfo.</TD>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
177<CODE>&nbsp;boolean</CODE></FONT></TD>
178<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#getDebug()">getDebug</A></B>()</CODE>
179
180<BR>
181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of debug.</TD>
182</TR>
183<TR BGCOLOR="white" CLASS="TableRowColor">
184<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
185<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
186<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#getDirName()">getDirName</A></B>()</CODE>
187
188<BR>
189&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of dirName.</TD>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
193<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
194<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#getEncoding()">getEncoding</A></B>()</CODE>
195
196<BR>
197&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of encoding.</TD>
198</TR>
199<TR BGCOLOR="white" CLASS="TableRowColor">
200<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
201<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
202<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#getModelName()">getModelName</A></B>()</CODE>
203
204<BR>
205&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of modelName.</TD>
206</TR>
207<TR BGCOLOR="white" CLASS="TableRowColor">
208<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
209<CODE>&nbsp;int</CODE></FONT></TD>
210<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#getNumPhrases()">getNumPhrases</A></B>()</CODE>
211
212<BR>
213&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of numPhrases.</TD>
214</TR>
215<TR BGCOLOR="white" CLASS="TableRowColor">
216<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
217<CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>
218<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#getOptions()">getOptions</A></B>()</CODE>
219
220<BR>
221&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the current option settings.</TD>
222</TR>
223<TR BGCOLOR="white" CLASS="TableRowColor">
224<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
225<CODE>&nbsp;java.util.Enumeration</CODE></FONT></TD>
226<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#listOptions()">listOptions</A></B>()</CODE>
227
228<BR>
229&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an enumeration describing the available options.</TD>
230</TR>
231<TR BGCOLOR="white" CLASS="TableRowColor">
232<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
233<CODE>&nbsp;void</CODE></FONT></TD>
234<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#loadModel()">loadModel</A></B>()</CODE>
235
236<BR>
237&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Loads the extraction model from the file.</TD>
238</TR>
239<TR BGCOLOR="white" CLASS="TableRowColor">
240<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
241<CODE>static&nbsp;void</CODE></FONT></TD>
242<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;ops)</CODE>
243
244<BR>
245&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The main method.</TD>
246</TR>
247<TR BGCOLOR="white" CLASS="TableRowColor">
248<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
249<CODE>&nbsp;void</CODE></FONT></TD>
250<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#setAdditionalInfo(boolean)">setAdditionalInfo</A></B>(boolean&nbsp;newAdditionalInfo)</CODE>
251
252<BR>
253&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value of AdditionalInfo.</TD>
254</TR>
255<TR BGCOLOR="white" CLASS="TableRowColor">
256<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
257<CODE>&nbsp;void</CODE></FONT></TD>
258<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#setDebug(boolean)">setDebug</A></B>(boolean&nbsp;newdebug)</CODE>
259
260<BR>
261&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value of debug.</TD>
262</TR>
263<TR BGCOLOR="white" CLASS="TableRowColor">
264<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
265<CODE>&nbsp;void</CODE></FONT></TD>
266<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#setDirName(java.lang.String)">setDirName</A></B>(java.lang.String&nbsp;newdirName)</CODE>
267
268<BR>
269&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value of dirName.</TD>
270</TR>
271<TR BGCOLOR="white" CLASS="TableRowColor">
272<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
273<CODE>&nbsp;void</CODE></FONT></TD>
274<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#setEncoding(java.lang.String)">setEncoding</A></B>(java.lang.String&nbsp;newencoding)</CODE>
275
276<BR>
277&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value of encoding.</TD>
278</TR>
279<TR BGCOLOR="white" CLASS="TableRowColor">
280<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
281<CODE>&nbsp;void</CODE></FONT></TD>
282<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#setModelName(java.lang.String)">setModelName</A></B>(java.lang.String&nbsp;newmodelName)</CODE>
283
284<BR>
285&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value of modelName.</TD>
286</TR>
287<TR BGCOLOR="white" CLASS="TableRowColor">
288<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
289<CODE>&nbsp;void</CODE></FONT></TD>
290<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#setNumPhrases(int)">setNumPhrases</A></B>(int&nbsp;newnumPhrases)</CODE>
291
292<BR>
293&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value of numPhrases.</TD>
294</TR>
295<TR BGCOLOR="white" CLASS="TableRowColor">
296<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
297<CODE>&nbsp;void</CODE></FONT></TD>
298<TD><CODE><B><A HREF="KEAKeyphraseExtractor.html#setOptions(java.lang.String[])">setOptions</A></B>(java.lang.String[]&nbsp;options)</CODE>
299
300<BR>
301&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parses a given list of options controlling the behaviour of this object.</TD>
302</TR>
303</TABLE>
304&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
305<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
306<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
307<TD><B>Methods inherited from class java.lang.Object</B></TD>
308</TR>
309<TR BGCOLOR="white" CLASS="TableRowColor">
310<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
311</TR>
312</TABLE>
313&nbsp;
314<P>
315
316<!-- ============ FIELD DETAIL =========== -->
317
318
319<!-- ========= CONSTRUCTOR DETAIL ======== -->
320
321<A NAME="constructor_detail"><!-- --></A>
322<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
323<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
324<TD COLSPAN=1><FONT SIZE="+2">
325<B>Constructor Detail</B></FONT></TD>
326</TR>
327</TABLE>
328
329<A NAME="KEAKeyphraseExtractor()"><!-- --></A><H3>
330KEAKeyphraseExtractor</H3>
331<PRE>
332public <B>KEAKeyphraseExtractor</B>()</PRE>
333<DL>
334</DL>
335
336<!-- ============ METHOD DETAIL ========== -->
337
338<A NAME="method_detail"><!-- --></A>
339<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
340<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
341<TD COLSPAN=1><FONT SIZE="+2">
342<B>Method Detail</B></FONT></TD>
343</TR>
344</TABLE>
345
346<A NAME="getAdditionalInfo()"><!-- --></A><H3>
347getAdditionalInfo</H3>
348<PRE>
349public boolean <B>getAdditionalInfo</B>()</PRE>
350<DL>
351<DD>Get the value of AdditionalInfo.
352<P>
353<DD><DL>
354</DL>
355</DD>
356<DD><DL>
357
358<DT><B>Returns:</B><DD>Value of AdditionalInfo.</DL>
359</DD>
360</DL>
361<HR>
362
363<A NAME="setAdditionalInfo(boolean)"><!-- --></A><H3>
364setAdditionalInfo</H3>
365<PRE>
366public void <B>setAdditionalInfo</B>(boolean&nbsp;newAdditionalInfo)</PRE>
367<DL>
368<DD>Set the value of AdditionalInfo.
369<P>
370<DD><DL>
371</DL>
372</DD>
373<DD><DL>
374<DT><B>Parameters:</B><DD><CODE>newAdditionalInfo</CODE> - Value to assign to AdditionalInfo.</DL>
375</DD>
376</DL>
377<HR>
378
379<A NAME="getNumPhrases()"><!-- --></A><H3>
380getNumPhrases</H3>
381<PRE>
382public int <B>getNumPhrases</B>()</PRE>
383<DL>
384<DD>Get the value of numPhrases.
385<P>
386<DD><DL>
387</DL>
388</DD>
389<DD><DL>
390
391<DT><B>Returns:</B><DD>Value of numPhrases.</DL>
392</DD>
393</DL>
394<HR>
395
396<A NAME="setNumPhrases(int)"><!-- --></A><H3>
397setNumPhrases</H3>
398<PRE>
399public void <B>setNumPhrases</B>(int&nbsp;newnumPhrases)</PRE>
400<DL>
401<DD>Set the value of numPhrases.
402<P>
403<DD><DL>
404</DL>
405</DD>
406<DD><DL>
407<DT><B>Parameters:</B><DD><CODE>newnumPhrases</CODE> - Value to assign to numPhrases.</DL>
408</DD>
409</DL>
410<HR>
411
412<A NAME="getDebug()"><!-- --></A><H3>
413getDebug</H3>
414<PRE>
415public boolean <B>getDebug</B>()</PRE>
416<DL>
417<DD>Get the value of debug.
418<P>
419<DD><DL>
420</DL>
421</DD>
422<DD><DL>
423
424<DT><B>Returns:</B><DD>Value of debug.</DL>
425</DD>
426</DL>
427<HR>
428
429<A NAME="setDebug(boolean)"><!-- --></A><H3>
430setDebug</H3>
431<PRE>
432public void <B>setDebug</B>(boolean&nbsp;newdebug)</PRE>
433<DL>
434<DD>Set the value of debug.
435<P>
436<DD><DL>
437</DL>
438</DD>
439<DD><DL>
440<DT><B>Parameters:</B><DD><CODE>newdebug</CODE> - Value to assign to debug.</DL>
441</DD>
442</DL>
443<HR>
444
445<A NAME="getEncoding()"><!-- --></A><H3>
446getEncoding</H3>
447<PRE>
448public java.lang.String <B>getEncoding</B>()</PRE>
449<DL>
450<DD>Get the value of encoding.
451<P>
452<DD><DL>
453</DL>
454</DD>
455<DD><DL>
456
457<DT><B>Returns:</B><DD>Value of encoding.</DL>
458</DD>
459</DL>
460<HR>
461
462<A NAME="setEncoding(java.lang.String)"><!-- --></A><H3>
463setEncoding</H3>
464<PRE>
465public void <B>setEncoding</B>(java.lang.String&nbsp;newencoding)</PRE>
466<DL>
467<DD>Set the value of encoding.
468<P>
469<DD><DL>
470</DL>
471</DD>
472<DD><DL>
473<DT><B>Parameters:</B><DD><CODE>newencoding</CODE> - Value to assign to encoding.</DL>
474</DD>
475</DL>
476<HR>
477
478<A NAME="getModelName()"><!-- --></A><H3>
479getModelName</H3>
480<PRE>
481public java.lang.String <B>getModelName</B>()</PRE>
482<DL>
483<DD>Get the value of modelName.
484<P>
485<DD><DL>
486</DL>
487</DD>
488<DD><DL>
489
490<DT><B>Returns:</B><DD>Value of modelName.</DL>
491</DD>
492</DL>
493<HR>
494
495<A NAME="setModelName(java.lang.String)"><!-- --></A><H3>
496setModelName</H3>
497<PRE>
498public void <B>setModelName</B>(java.lang.String&nbsp;newmodelName)</PRE>
499<DL>
500<DD>Set the value of modelName.
501<P>
502<DD><DL>
503</DL>
504</DD>
505<DD><DL>
506<DT><B>Parameters:</B><DD><CODE>newmodelName</CODE> - Value to assign to modelName.</DL>
507</DD>
508</DL>
509<HR>
510
511<A NAME="getDirName()"><!-- --></A><H3>
512getDirName</H3>
513<PRE>
514public java.lang.String <B>getDirName</B>()</PRE>
515<DL>
516<DD>Get the value of dirName.
517<P>
518<DD><DL>
519</DL>
520</DD>
521<DD><DL>
522
523<DT><B>Returns:</B><DD>Value of dirName.</DL>
524</DD>
525</DL>
526<HR>
527
528<A NAME="setDirName(java.lang.String)"><!-- --></A><H3>
529setDirName</H3>
530<PRE>
531public void <B>setDirName</B>(java.lang.String&nbsp;newdirName)</PRE>
532<DL>
533<DD>Set the value of dirName.
534<P>
535<DD><DL>
536</DL>
537</DD>
538<DD><DL>
539<DT><B>Parameters:</B><DD><CODE>newdirName</CODE> - Value to assign to dirName.</DL>
540</DD>
541</DL>
542<HR>
543
544<A NAME="setOptions(java.lang.String[])"><!-- --></A><H3>
545setOptions</H3>
546<PRE>
547public void <B>setOptions</B>(java.lang.String[]&nbsp;options)
548 throws java.lang.Exception</PRE>
549<DL>
550<DD>Parses a given list of options controlling the behaviour of this object.
551 Valid options are:<p>
552
553 -l "directory name"<br>
554 Specifies name of directory.<p>
555
556 -m "model name"<br>
557 Specifies name of model.<p>
558
559 -e "encoding"<br>
560 Specifies encoding.<p>
561
562 -n<br>
563 Specifies number of phrases to be output (default: 5).<p>
564
565 -d<br>
566 Turns debugging mode on.<p>
567
568 -a<br>
569 Also write stemmed phrase and score into ".key" file.<p>
570<P>
571<DD><DL>
572<DT><B>Specified by:</B><DD><CODE>setOptions</CODE> in interface <CODE>weka.core.OptionHandler</CODE></DL>
573</DD>
574<DD><DL>
575<DT><B>Parameters:</B><DD><CODE>options</CODE> - the list of options as an array of strings
576<DT><B>Throws:</B>
577<DD><CODE>java.lang.Exception</CODE> - if an option is not supported</DL>
578</DD>
579</DL>
580<HR>
581
582<A NAME="getOptions()"><!-- --></A><H3>
583getOptions</H3>
584<PRE>
585public java.lang.String[] <B>getOptions</B>()</PRE>
586<DL>
587<DD>Gets the current option settings.
588<P>
589<DD><DL>
590<DT><B>Specified by:</B><DD><CODE>getOptions</CODE> in interface <CODE>weka.core.OptionHandler</CODE></DL>
591</DD>
592<DD><DL>
593
594<DT><B>Returns:</B><DD>an array of strings suitable for passing to setOptions</DL>
595</DD>
596</DL>
597<HR>
598
599<A NAME="listOptions()"><!-- --></A><H3>
600listOptions</H3>
601<PRE>
602public java.util.Enumeration <B>listOptions</B>()</PRE>
603<DL>
604<DD>Returns an enumeration describing the available options.
605<P>
606<DD><DL>
607<DT><B>Specified by:</B><DD><CODE>listOptions</CODE> in interface <CODE>weka.core.OptionHandler</CODE></DL>
608</DD>
609<DD><DL>
610
611<DT><B>Returns:</B><DD>an enumeration of all the available options</DL>
612</DD>
613</DL>
614<HR>
615
616<A NAME="collectStems()"><!-- --></A><H3>
617collectStems</H3>
618<PRE>
619public java.util.Hashtable <B>collectStems</B>()
620 throws java.lang.Exception</PRE>
621<DL>
622<DD>Collects the stems of the file names.
623<P>
624<DD><DL>
625</DL>
626</DD>
627<DD><DL>
628
629<DD><CODE>java.lang.Exception</CODE></DL>
630</DD>
631</DL>
632<HR>
633
634<A NAME="extractKeyphrases(java.util.Hashtable)"><!-- --></A><H3>
635extractKeyphrases</H3>
636<PRE>
637public void <B>extractKeyphrases</B>(java.util.Hashtable&nbsp;stems)
638 throws java.lang.Exception</PRE>
639<DL>
640<DD>Builds the model from the files
641<P>
642<DD><DL>
643</DL>
644</DD>
645<DD><DL>
646
647<DD><CODE>java.lang.Exception</CODE></DL>
648</DD>
649</DL>
650<HR>
651
652<A NAME="loadModel()"><!-- --></A><H3>
653loadModel</H3>
654<PRE>
655public void <B>loadModel</B>()
656 throws java.lang.Exception</PRE>
657<DL>
658<DD>Loads the extraction model from the file.
659<P>
660<DD><DL>
661</DL>
662</DD>
663<DD><DL>
664
665<DD><CODE>java.lang.Exception</CODE></DL>
666</DD>
667</DL>
668<HR>
669
670<A NAME="main(java.lang.String[])"><!-- --></A><H3>
671main</H3>
672<PRE>
673public static void <B>main</B>(java.lang.String[]&nbsp;ops)</PRE>
674<DL>
675<DD>The main method.
676<P>
677<DD><DL>
678</DL>
679</DD>
680<DD><DL>
681</DL>
682</DD>
683</DL>
684<!-- ========= END OF CLASS DATA ========= -->
685<HR>
686
687<!-- ========== START OF NAVBAR ========== -->
688<A NAME="navbar_bottom"><!-- --></A>
689<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
690<TR>
691<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
692<A NAME="navbar_bottom_firstrow"><!-- --></A>
693<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
694 <TR ALIGN="center" VALIGN="top">
695 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
696&nbsp;</TD>
697 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
698 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
699 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
700 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
701 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
702 </TR>
703</TABLE>
704</TD>
705<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
706</EM>
707</TD>
708</TR>
709
710<TR>
711<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
712&nbsp;<A HREF="KEAFilter.html"><B>PREV CLASS</B></A>&nbsp;
713&nbsp;<A HREF="KEAModelBuilder.html"><B>NEXT CLASS</B></A></FONT></TD>
714<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
715 <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A> &nbsp;
716&nbsp;<A HREF="KEAKeyphraseExtractor.html" TARGET="_top"><B>NO FRAMES</B></A> &nbsp;
717&nbsp;
718<SCRIPT>
719 <!--
720 if(window==top) {
721 document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
722 }
723 //-->
724</SCRIPT>
725<NOSCRIPT>
726<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
727</NOSCRIPT>
728</FONT></TD>
729</TR>
730<TR>
731<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
732 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
733<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
734DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
735</TR>
736</TABLE>
737<!-- =========== END OF NAVBAR =========== -->
738
739<HR>
740
741</BODY>
742</HTML>
Note: See TracBrowser for help on using the repository browser.