source: trunk/gsdl/packages/kea/kea-3.0/doc/KEAPhraseFilter.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: 26.5 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>
7KEAPhraseFilter
8</TITLE>
9<META NAME="keywords" CONTENT="KEAPhraseFilter,KEAPhraseFilter class">
10<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
11</HEAD>
12<SCRIPT>
13function asd()
14{
15parent.document.title="KEAPhraseFilter";
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="KEAModelBuilder.html"><B>PREV CLASS</B></A>&nbsp;
46&nbsp;<A HREF="LovinsStemmer.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="KEAPhraseFilter.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;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&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 KEAPhraseFilter</H2>
76<PRE>
77java.lang.Object
78 |
79 +--weka.filters.Filter
80 |
81 +--<B>KEAPhraseFilter</B>
82</PRE>
83<DL>
84<DT><B>All Implemented Interfaces:</B> <DD>weka.core.OptionHandler, java.io.Serializable</DD>
85</DL>
86<HR>
87<DL>
88<DT>public class <B>KEAPhraseFilter</B><DT>extends weka.filters.Filter<DT>implements weka.core.OptionHandler</DL>
89
90<P>
91This filter splits the text in selected string
92 attributes into phrases. The resulting
93 string attributes contain these phrases
94 separated by '\n' characters.
95
96 Phrases are identified according to the
97 following definitions:
98
99 A phrase is a sequence of words interrupted
100 only by sequences of whitespace characters,
101 where each sequence of whitespace characters
102 contains at most one '\n'.
103
104 A word is a sequence of letters or digits
105 that contains at least one letter, with
106 the following exceptions:
107
108 a) '.', '@', '_', '&', '/', '-' are allowed
109 if surrounded by letters or digits,
110
111 b) '\'' is allowed if preceeded by a letter
112 or digit,
113
114 c) '-', '/' are also allowed if succeeded by
115 whitespace characters followed by another
116 word. In that case the whitespace characters
117 will be deleted.
118<P>
119
120<P>
121<DL>
122<DT><B>See Also:</B><DD><A HREF="serialized-form.html" TARGET="KEAPhraseFilter">Serialized Form</A></DL>
123<HR>
124
125<P>
126<!-- ======== NESTED CLASS SUMMARY ======== -->
127
128
129<!-- =========== FIELD SUMMARY =========== -->
130
131<A NAME="field_summary"><!-- --></A>
132<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
133<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
134<TD COLSPAN=2><FONT SIZE="+2">
135<B>Field Summary</B></FONT></TD>
136</TR>
137<TR BGCOLOR="white" CLASS="TableRowColor">
138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139<CODE>protected &nbsp;boolean</CODE></FONT></TD>
140<TD><CODE><B><A HREF="KEAPhraseFilter.html#m_DisallowInternalPeriods">m_DisallowInternalPeriods</A></B></CODE>
141
142<BR>
143&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines whether internal periods are allowed</TD>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147<CODE>protected &nbsp;weka.core.Range</CODE></FONT></TD>
148<TD><CODE><B><A HREF="KEAPhraseFilter.html#m_SelectCols">m_SelectCols</A></B></CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stores which columns to select as a funky range</TD>
152</TR>
153</TABLE>
154&nbsp;<A NAME="fields_inherited_from_class_weka.filters.Filter"><!-- --></A>
155<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
156<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
157<TD><B>Fields inherited from class weka.filters.Filter</B></TD>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD><CODE>m_NewBatch</CODE></TD>
161</TR>
162</TABLE>
163&nbsp;
164<!-- ======== CONSTRUCTOR SUMMARY ======== -->
165
166<A NAME="constructor_summary"><!-- --></A>
167<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
168<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
169<TD COLSPAN=2><FONT SIZE="+2">
170<B>Constructor Summary</B></FONT></TD>
171</TR>
172<TR BGCOLOR="white" CLASS="TableRowColor">
173<TD><CODE><B><A HREF="KEAPhraseFilter.html#KEAPhraseFilter()">KEAPhraseFilter</A></B>()</CODE>
174
175<BR>
176&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
177</TR>
178</TABLE>
179&nbsp;
180<!-- ========== METHOD SUMMARY =========== -->
181
182<A NAME="method_summary"><!-- --></A>
183<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
184<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
185<TD COLSPAN=2><FONT SIZE="+2">
186<B>Method Summary</B></FONT></TD>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
190<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
191<TD><CODE><B><A HREF="KEAPhraseFilter.html#attributeIndicesTipText()">attributeIndicesTipText</A></B>()</CODE>
192
193<BR>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the tip text for this property</TD>
195</TR>
196<TR BGCOLOR="white" CLASS="TableRowColor">
197<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
198<CODE>&nbsp;boolean</CODE></FONT></TD>
199<TD><CODE><B><A HREF="KEAPhraseFilter.html#batchFinished()">batchFinished</A></B>()</CODE>
200
201<BR>
202&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signify that this batch of input to the filter is finished.</TD>
203</TR>
204<TR BGCOLOR="white" CLASS="TableRowColor">
205<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
206<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
207<TD><CODE><B><A HREF="KEAPhraseFilter.html#disallowInternalPeriodsTipText()">disallowInternalPeriodsTipText</A></B>()</CODE>
208
209<BR>
210&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the tip text for this property</TD>
211</TR>
212<TR BGCOLOR="white" CLASS="TableRowColor">
213<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
214<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
215<TD><CODE><B><A HREF="KEAPhraseFilter.html#getAttributeIndices()">getAttributeIndices</A></B>()</CODE>
216
217<BR>
218&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the current range selection.</TD>
219</TR>
220<TR BGCOLOR="white" CLASS="TableRowColor">
221<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
222<CODE>&nbsp;boolean</CODE></FONT></TD>
223<TD><CODE><B><A HREF="KEAPhraseFilter.html#getDisallowInternalPeriods()">getDisallowInternalPeriods</A></B>()</CODE>
224
225<BR>
226&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get whether the supplied columns are to be processed</TD>
227</TR>
228<TR BGCOLOR="white" CLASS="TableRowColor">
229<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
230<CODE>&nbsp;boolean</CODE></FONT></TD>
231<TD><CODE><B><A HREF="KEAPhraseFilter.html#getInvertSelection()">getInvertSelection</A></B>()</CODE>
232
233<BR>
234&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get whether the supplied columns are to be processed</TD>
235</TR>
236<TR BGCOLOR="white" CLASS="TableRowColor">
237<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
238<CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>
239<TD><CODE><B><A HREF="KEAPhraseFilter.html#getOptions()">getOptions</A></B>()</CODE>
240
241<BR>
242&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the current settings of the filter.</TD>
243</TR>
244<TR BGCOLOR="white" CLASS="TableRowColor">
245<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
246<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
247<TD><CODE><B><A HREF="KEAPhraseFilter.html#globalInfo()">globalInfo</A></B>()</CODE>
248
249<BR>
250&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string describing this filter</TD>
251</TR>
252<TR BGCOLOR="white" CLASS="TableRowColor">
253<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
254<CODE>&nbsp;boolean</CODE></FONT></TD>
255<TD><CODE><B><A HREF="KEAPhraseFilter.html#input(weka.core.Instance)">input</A></B>(weka.core.Instance&nbsp;instance)</CODE>
256
257<BR>
258&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Input an instance for filtering.</TD>
259</TR>
260<TR BGCOLOR="white" CLASS="TableRowColor">
261<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
262<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
263<TD><CODE><B><A HREF="KEAPhraseFilter.html#invertSelectionTipText()">invertSelectionTipText</A></B>()</CODE>
264
265<BR>
266&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the tip text for this property</TD>
267</TR>
268<TR BGCOLOR="white" CLASS="TableRowColor">
269<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
270<CODE>&nbsp;java.util.Enumeration</CODE></FONT></TD>
271<TD><CODE><B><A HREF="KEAPhraseFilter.html#listOptions()">listOptions</A></B>()</CODE>
272
273<BR>
274&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an enumeration describing the available options</TD>
275</TR>
276<TR BGCOLOR="white" CLASS="TableRowColor">
277<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
278<CODE>static&nbsp;void</CODE></FONT></TD>
279<TD><CODE><B><A HREF="KEAPhraseFilter.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;argv)</CODE>
280
281<BR>
282&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Main method for testing this class.</TD>
283</TR>
284<TR BGCOLOR="white" CLASS="TableRowColor">
285<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
286<CODE>&nbsp;void</CODE></FONT></TD>
287<TD><CODE><B><A HREF="KEAPhraseFilter.html#setAttributeIndices(java.lang.String)">setAttributeIndices</A></B>(java.lang.String&nbsp;rangeList)</CODE>
288
289<BR>
290&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set which attributes are to be processed</TD>
291</TR>
292<TR BGCOLOR="white" CLASS="TableRowColor">
293<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
294<CODE>&nbsp;void</CODE></FONT></TD>
295<TD><CODE><B><A HREF="KEAPhraseFilter.html#setAttributeIndicesArray(int[])">setAttributeIndicesArray</A></B>(int[]&nbsp;attributes)</CODE>
296
297<BR>
298&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set which attributes are to be processed</TD>
299</TR>
300<TR BGCOLOR="white" CLASS="TableRowColor">
301<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
302<CODE>&nbsp;void</CODE></FONT></TD>
303<TD><CODE><B><A HREF="KEAPhraseFilter.html#setDisallowInternalPeriods(boolean)">setDisallowInternalPeriods</A></B>(boolean&nbsp;disallow)</CODE>
304
305<BR>
306&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set whether selected columns should be processed.</TD>
307</TR>
308<TR BGCOLOR="white" CLASS="TableRowColor">
309<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
310<CODE>&nbsp;boolean</CODE></FONT></TD>
311<TD><CODE><B><A HREF="KEAPhraseFilter.html#setInputFormat(weka.core.Instances)">setInputFormat</A></B>(weka.core.Instances&nbsp;instanceInfo)</CODE>
312
313<BR>
314&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the format of the input instances.</TD>
315</TR>
316<TR BGCOLOR="white" CLASS="TableRowColor">
317<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
318<CODE>&nbsp;void</CODE></FONT></TD>
319<TD><CODE><B><A HREF="KEAPhraseFilter.html#setInvertSelection(boolean)">setInvertSelection</A></B>(boolean&nbsp;invert)</CODE>
320
321<BR>
322&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set whether selected columns should be processed.</TD>
323</TR>
324<TR BGCOLOR="white" CLASS="TableRowColor">
325<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
326<CODE>&nbsp;void</CODE></FONT></TD>
327<TD><CODE><B><A HREF="KEAPhraseFilter.html#setOptions(java.lang.String[])">setOptions</A></B>(java.lang.String[]&nbsp;options)</CODE>
328
329<BR>
330&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parses a given list of options controlling the behaviour of this object.</TD>
331</TR>
332</TABLE>
333&nbsp;<A NAME="methods_inherited_from_class_weka.filters.Filter"><!-- --></A>
334<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
335<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
336<TD><B>Methods inherited from class weka.filters.Filter</B></TD>
337</TR>
338<TR BGCOLOR="white" CLASS="TableRowColor">
339<TD><CODE>batchFilterFile, bufferInput, copyStringValues, copyStringValues, filterFile, flushInput, getInputFormat, getInputStringIndex, getOutputFormat, getOutputStringIndex, getStringIndices, inputFormat, isOutputFormatDefined, numPendingOutput, output, outputFormat, outputFormatPeek, outputPeek, push, resetQueue, setOutputFormat, useFilter</CODE></TD>
340</TR>
341</TABLE>
342&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
343<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
344<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
345<TD><B>Methods inherited from class java.lang.Object</B></TD>
346</TR>
347<TR BGCOLOR="white" CLASS="TableRowColor">
348<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
349</TR>
350</TABLE>
351&nbsp;
352<P>
353
354<!-- ============ FIELD DETAIL =========== -->
355
356<A NAME="field_detail"><!-- --></A>
357<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
358<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
359<TD COLSPAN=1><FONT SIZE="+2">
360<B>Field Detail</B></FONT></TD>
361</TR>
362</TABLE>
363
364<A NAME="m_SelectCols"><!-- --></A><H3>
365m_SelectCols</H3>
366<PRE>
367protected weka.core.Range <B>m_SelectCols</B></PRE>
368<DL>
369<DD>Stores which columns to select as a funky range
370<P>
371<DL>
372</DL>
373</DL>
374<HR>
375
376<A NAME="m_DisallowInternalPeriods"><!-- --></A><H3>
377m_DisallowInternalPeriods</H3>
378<PRE>
379protected boolean <B>m_DisallowInternalPeriods</B></PRE>
380<DL>
381<DD>Determines whether internal periods are allowed
382<P>
383<DL>
384</DL>
385</DL>
386
387<!-- ========= CONSTRUCTOR DETAIL ======== -->
388
389<A NAME="constructor_detail"><!-- --></A>
390<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
391<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
392<TD COLSPAN=1><FONT SIZE="+2">
393<B>Constructor Detail</B></FONT></TD>
394</TR>
395</TABLE>
396
397<A NAME="KEAPhraseFilter()"><!-- --></A><H3>
398KEAPhraseFilter</H3>
399<PRE>
400public <B>KEAPhraseFilter</B>()</PRE>
401<DL>
402</DL>
403
404<!-- ============ METHOD DETAIL ========== -->
405
406<A NAME="method_detail"><!-- --></A>
407<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
408<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
409<TD COLSPAN=1><FONT SIZE="+2">
410<B>Method Detail</B></FONT></TD>
411</TR>
412</TABLE>
413
414<A NAME="globalInfo()"><!-- --></A><H3>
415globalInfo</H3>
416<PRE>
417public java.lang.String <B>globalInfo</B>()</PRE>
418<DL>
419<DD>Returns a string describing this filter
420<P>
421<DD><DL>
422</DL>
423</DD>
424<DD><DL>
425
426<DT><B>Returns:</B><DD>a description of the filter suitable for
427 displaying in the explorer/experimenter gui</DL>
428</DD>
429</DL>
430<HR>
431
432<A NAME="listOptions()"><!-- --></A><H3>
433listOptions</H3>
434<PRE>
435public java.util.Enumeration <B>listOptions</B>()</PRE>
436<DL>
437<DD>Returns an enumeration describing the available options
438<P>
439<DD><DL>
440<DT><B>Specified by:</B><DD><CODE>listOptions</CODE> in interface <CODE>weka.core.OptionHandler</CODE></DL>
441</DD>
442<DD><DL>
443
444<DT><B>Returns:</B><DD>an enumeration of all the available options</DL>
445</DD>
446</DL>
447<HR>
448
449<A NAME="setOptions(java.lang.String[])"><!-- --></A><H3>
450setOptions</H3>
451<PRE>
452public void <B>setOptions</B>(java.lang.String[]&nbsp;options)
453 throws java.lang.Exception</PRE>
454<DL>
455<DD>Parses a given list of options controlling the behaviour of this object.
456 Valid options are:<p>
457
458 -R index1,index2-index4,...<br>
459 Specify list of attributes to process. First and last are valid indexes.
460 (default none)<p>
461
462 -V<br>
463 Invert matching sense <p>
464
465 -P<br>
466 Disallow internal periods <p>
467<P>
468<DD><DL>
469<DT><B>Specified by:</B><DD><CODE>setOptions</CODE> in interface <CODE>weka.core.OptionHandler</CODE></DL>
470</DD>
471<DD><DL>
472<DT><B>Parameters:</B><DD><CODE>options</CODE> - the list of options as an array of strings
473<DT><B>Throws:</B>
474<DD><CODE>java.lang.Exception</CODE> - if an option is not supported</DL>
475</DD>
476</DL>
477<HR>
478
479<A NAME="getOptions()"><!-- --></A><H3>
480getOptions</H3>
481<PRE>
482public java.lang.String[] <B>getOptions</B>()</PRE>
483<DL>
484<DD>Gets the current settings of the filter.
485<P>
486<DD><DL>
487<DT><B>Specified by:</B><DD><CODE>getOptions</CODE> in interface <CODE>weka.core.OptionHandler</CODE></DL>
488</DD>
489<DD><DL>
490
491<DT><B>Returns:</B><DD>an array of strings suitable for passing to setOptions</DL>
492</DD>
493</DL>
494<HR>
495
496<A NAME="setInputFormat(weka.core.Instances)"><!-- --></A><H3>
497setInputFormat</H3>
498<PRE>
499public boolean <B>setInputFormat</B>(weka.core.Instances&nbsp;instanceInfo)
500 throws java.lang.Exception</PRE>
501<DL>
502<DD>Sets the format of the input instances.
503<P>
504<DD><DL>
505<DT><B>Overrides:</B><DD><CODE>setInputFormat</CODE> in class <CODE>weka.filters.Filter</CODE></DL>
506</DD>
507<DD><DL>
508<DT><B>Parameters:</B><DD><CODE>instanceInfo</CODE> - an Instances object containing the input
509 instance structure (any instances contained in the object are
510 ignored - only the structure is required).
511<DT><B>Returns:</B><DD>true if the outputFormat may be collected immediately
512<DD><CODE>java.lang.Exception</CODE></DL>
513</DD>
514</DL>
515<HR>
516
517<A NAME="input(weka.core.Instance)"><!-- --></A><H3>
518input</H3>
519<PRE>
520public boolean <B>input</B>(weka.core.Instance&nbsp;instance)
521 throws java.lang.Exception</PRE>
522<DL>
523<DD>Input an instance for filtering. Ordinarily the instance is processed
524 and made available for output immediately. Some filters require all
525 instances be read before producing output.
526<P>
527<DD><DL>
528<DT><B>Overrides:</B><DD><CODE>input</CODE> in class <CODE>weka.filters.Filter</CODE></DL>
529</DD>
530<DD><DL>
531<DT><B>Parameters:</B><DD><CODE>instance</CODE> - the input instance
532<DT><B>Returns:</B><DD>true if the filtered instance may now be
533 collected with output().
534<DT><B>Throws:</B>
535<DD><CODE>java.lang.Exception</CODE> - if the input instance was not of the correct
536 format or if there was a problem with the filtering.</DL>
537</DD>
538</DL>
539<HR>
540
541<A NAME="batchFinished()"><!-- --></A><H3>
542batchFinished</H3>
543<PRE>
544public boolean <B>batchFinished</B>()
545 throws java.lang.Exception</PRE>
546<DL>
547<DD>Signify that this batch of input to the filter is finished. If
548 the filter requires all instances prior to filtering, output()
549 may now be called to retrieve the filtered instances. Any
550 subsequent instances filtered should be filtered based on setting
551 obtained from the first batch (unless the inputFormat has been
552 re-assigned or new options have been set). This default
553 implementation assumes all instance processing occurs during
554 inputFormat() and input().
555<P>
556<DD><DL>
557<DT><B>Overrides:</B><DD><CODE>batchFinished</CODE> in class <CODE>weka.filters.Filter</CODE></DL>
558</DD>
559<DD><DL>
560
561<DT><B>Returns:</B><DD>true if there are instances pending output
562<DT><B>Throws:</B>
563<DD><CODE>java.lang.NullPointerException</CODE> - if no input structure has been defined,
564<DD><CODE>java.lang.Exception</CODE> - if there was a problem finishing the batch.</DL>
565</DD>
566</DL>
567<HR>
568
569<A NAME="main(java.lang.String[])"><!-- --></A><H3>
570main</H3>
571<PRE>
572public static void <B>main</B>(java.lang.String[]&nbsp;argv)</PRE>
573<DL>
574<DD>Main method for testing this class.
575<P>
576<DD><DL>
577</DL>
578</DD>
579<DD><DL>
580<DT><B>Parameters:</B><DD><CODE>argv</CODE> - should contain arguments to the filter: use -h for help</DL>
581</DD>
582</DL>
583<HR>
584
585<A NAME="invertSelectionTipText()"><!-- --></A><H3>
586invertSelectionTipText</H3>
587<PRE>
588public java.lang.String <B>invertSelectionTipText</B>()</PRE>
589<DL>
590<DD>Returns the tip text for this property
591<P>
592<DD><DL>
593</DL>
594</DD>
595<DD><DL>
596
597<DT><B>Returns:</B><DD>tip text for this property suitable for
598 displaying in the explorer/experimenter gui</DL>
599</DD>
600</DL>
601<HR>
602
603<A NAME="getInvertSelection()"><!-- --></A><H3>
604getInvertSelection</H3>
605<PRE>
606public boolean <B>getInvertSelection</B>()</PRE>
607<DL>
608<DD>Get whether the supplied columns are to be processed
609<P>
610<DD><DL>
611</DL>
612</DD>
613<DD><DL>
614
615<DT><B>Returns:</B><DD>true if the supplied columns won't be processed</DL>
616</DD>
617</DL>
618<HR>
619
620<A NAME="setInvertSelection(boolean)"><!-- --></A><H3>
621setInvertSelection</H3>
622<PRE>
623public void <B>setInvertSelection</B>(boolean&nbsp;invert)</PRE>
624<DL>
625<DD>Set whether selected columns should be processed. If true the
626 selected columns won't be processed.
627<P>
628<DD><DL>
629</DL>
630</DD>
631<DD><DL>
632<DT><B>Parameters:</B><DD><CODE>invert</CODE> - the new invert setting</DL>
633</DD>
634</DL>
635<HR>
636
637<A NAME="disallowInternalPeriodsTipText()"><!-- --></A><H3>
638disallowInternalPeriodsTipText</H3>
639<PRE>
640public java.lang.String <B>disallowInternalPeriodsTipText</B>()</PRE>
641<DL>
642<DD>Returns the tip text for this property
643<P>
644<DD><DL>
645</DL>
646</DD>
647<DD><DL>
648
649<DT><B>Returns:</B><DD>tip text for this property suitable for
650 displaying in the explorer/experimenter gui</DL>
651</DD>
652</DL>
653<HR>
654
655<A NAME="getDisallowInternalPeriods()"><!-- --></A><H3>
656getDisallowInternalPeriods</H3>
657<PRE>
658public boolean <B>getDisallowInternalPeriods</B>()</PRE>
659<DL>
660<DD>Get whether the supplied columns are to be processed
661<P>
662<DD><DL>
663</DL>
664</DD>
665<DD><DL>
666
667<DT><B>Returns:</B><DD>true if the supplied columns won't be processed</DL>
668</DD>
669</DL>
670<HR>
671
672<A NAME="setDisallowInternalPeriods(boolean)"><!-- --></A><H3>
673setDisallowInternalPeriods</H3>
674<PRE>
675public void <B>setDisallowInternalPeriods</B>(boolean&nbsp;disallow)</PRE>
676<DL>
677<DD>Set whether selected columns should be processed. If true the
678 selected columns won't be processed.
679<P>
680<DD><DL>
681</DL>
682</DD>
683<DD><DL>
684</DL>
685</DD>
686</DL>
687<HR>
688
689<A NAME="attributeIndicesTipText()"><!-- --></A><H3>
690attributeIndicesTipText</H3>
691<PRE>
692public java.lang.String <B>attributeIndicesTipText</B>()</PRE>
693<DL>
694<DD>Returns the tip text for this property
695<P>
696<DD><DL>
697</DL>
698</DD>
699<DD><DL>
700
701<DT><B>Returns:</B><DD>tip text for this property suitable for
702 displaying in the explorer/experimenter gui</DL>
703</DD>
704</DL>
705<HR>
706
707<A NAME="getAttributeIndices()"><!-- --></A><H3>
708getAttributeIndices</H3>
709<PRE>
710public java.lang.String <B>getAttributeIndices</B>()</PRE>
711<DL>
712<DD>Get the current range selection.
713<P>
714<DD><DL>
715</DL>
716</DD>
717<DD><DL>
718
719<DT><B>Returns:</B><DD>a string containing a comma separated list of ranges</DL>
720</DD>
721</DL>
722<HR>
723
724<A NAME="setAttributeIndices(java.lang.String)"><!-- --></A><H3>
725setAttributeIndices</H3>
726<PRE>
727public void <B>setAttributeIndices</B>(java.lang.String&nbsp;rangeList)</PRE>
728<DL>
729<DD>Set which attributes are to be processed
730<P>
731<DD><DL>
732</DL>
733</DD>
734<DD><DL>
735<DT><B>Parameters:</B><DD><CODE>rangeList</CODE> - a string representing the list of attributes. Since
736 the string will typically come from a user, attributes are indexed from
737 1. <br>
738 eg: first-3,5,6-last</DL>
739</DD>
740</DL>
741<HR>
742
743<A NAME="setAttributeIndicesArray(int[])"><!-- --></A><H3>
744setAttributeIndicesArray</H3>
745<PRE>
746public void <B>setAttributeIndicesArray</B>(int[]&nbsp;attributes)</PRE>
747<DL>
748<DD>Set which attributes are to be processed
749<P>
750<DD><DL>
751</DL>
752</DD>
753<DD><DL>
754<DT><B>Parameters:</B><DD><CODE>attributes</CODE> - an array containing indexes of attributes to select.
755 Since the array will typically come from a program, attributes are indexed
756 from 0.</DL>
757</DD>
758</DL>
759<!-- ========= END OF CLASS DATA ========= -->
760<HR>
761
762<!-- ========== START OF NAVBAR ========== -->
763<A NAME="navbar_bottom"><!-- --></A>
764<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
765<TR>
766<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
767<A NAME="navbar_bottom_firstrow"><!-- --></A>
768<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
769 <TR ALIGN="center" VALIGN="top">
770 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
771&nbsp;</TD>
772 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
773 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
774 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
775 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
776 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
777 </TR>
778</TABLE>
779</TD>
780<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
781</EM>
782</TD>
783</TR>
784
785<TR>
786<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
787&nbsp;<A HREF="KEAModelBuilder.html"><B>PREV CLASS</B></A>&nbsp;
788&nbsp;<A HREF="LovinsStemmer.html"><B>NEXT CLASS</B></A></FONT></TD>
789<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
790 <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A> &nbsp;
791&nbsp;<A HREF="KEAPhraseFilter.html" TARGET="_top"><B>NO FRAMES</B></A> &nbsp;
792&nbsp;
793<SCRIPT>
794 <!--
795 if(window==top) {
796 document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
797 }
798 //-->
799</SCRIPT>
800<NOSCRIPT>
801<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
802</NOSCRIPT>
803</FONT></TD>
804</TR>
805<TR>
806<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
807 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
808<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
809DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
810</TR>
811</TABLE>
812<!-- =========== END OF NAVBAR =========== -->
813
814<HR>
815
816</BODY>
817</HTML>
Note: See TracBrowser for help on using the repository browser.