source: trunk/gsdl/packages/kea/kea-3.0/doc/NumbersFilter.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: 14.1 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:50 NZDT 2004 -->
6<TITLE>
7NumbersFilter
8</TITLE>
9<META NAME="keywords" CONTENT="NumbersFilter,NumbersFilter class">
10<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
11</HEAD>
12<SCRIPT>
13function asd()
14{
15parent.document.title="NumbersFilter";
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="LovinsStemmer.html"><B>PREV CLASS</B></A>&nbsp;
46&nbsp;<A HREF="Stemmer.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="NumbersFilter.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="#fields_inherited_from_class_weka.filters.Filter">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;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 NumbersFilter</H2>
76<PRE>
77java.lang.Object
78 |
79 +--weka.filters.Filter
80 |
81 +--<B>NumbersFilter</B>
82</PRE>
83<DL>
84<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
85</DL>
86<HR>
87<DL>
88<DT>public class <B>NumbersFilter</B><DT>extends weka.filters.Filter</DL>
89
90<P>
91Removes all numbers from all the string attributes in the given
92 dataset. Assumes that words are separated by whitespace.
93<P>
94
95<P>
96<DL>
97<DT><B>See Also:</B><DD><A HREF="serialized-form.html" TARGET="NumbersFilter">Serialized Form</A></DL>
98<HR>
99
100<P>
101<!-- ======== NESTED CLASS SUMMARY ======== -->
102
103
104<!-- =========== FIELD SUMMARY =========== -->
105
106<A NAME="field_summary"><!-- --></A>
107<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
108<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
109<TD COLSPAN=2><FONT SIZE="+2">
110<B>Field Summary</B></FONT></TD>
111</TR>
112</TABLE>
113&nbsp;<A NAME="fields_inherited_from_class_weka.filters.Filter"><!-- --></A>
114<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
115<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
116<TD><B>Fields inherited from class weka.filters.Filter</B></TD>
117</TR>
118<TR BGCOLOR="white" CLASS="TableRowColor">
119<TD><CODE>m_NewBatch</CODE></TD>
120</TR>
121</TABLE>
122&nbsp;
123<!-- ======== CONSTRUCTOR SUMMARY ======== -->
124
125<A NAME="constructor_summary"><!-- --></A>
126<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
127<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
128<TD COLSPAN=2><FONT SIZE="+2">
129<B>Constructor Summary</B></FONT></TD>
130</TR>
131<TR BGCOLOR="white" CLASS="TableRowColor">
132<TD><CODE><B><A HREF="NumbersFilter.html#NumbersFilter()">NumbersFilter</A></B>()</CODE>
133
134<BR>
135&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
136</TR>
137</TABLE>
138&nbsp;
139<!-- ========== METHOD SUMMARY =========== -->
140
141<A NAME="method_summary"><!-- --></A>
142<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
143<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
144<TD COLSPAN=2><FONT SIZE="+2">
145<B>Method Summary</B></FONT></TD>
146</TR>
147<TR BGCOLOR="white" CLASS="TableRowColor">
148<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
149<CODE>&nbsp;boolean</CODE></FONT></TD>
150<TD><CODE><B><A HREF="NumbersFilter.html#batchFinished()">batchFinished</A></B>()</CODE>
151
152<BR>
153&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signify that this batch of input to the filter is finished.</TD>
154</TR>
155<TR BGCOLOR="white" CLASS="TableRowColor">
156<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
158<TD><CODE><B><A HREF="NumbersFilter.html#globalInfo()">globalInfo</A></B>()</CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string describing this filter</TD>
162</TR>
163<TR BGCOLOR="white" CLASS="TableRowColor">
164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165<CODE>&nbsp;boolean</CODE></FONT></TD>
166<TD><CODE><B><A HREF="NumbersFilter.html#input(weka.core.Instance)">input</A></B>(weka.core.Instance&nbsp;instance)</CODE>
167
168<BR>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Input an instance for filtering.</TD>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
172<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
173<CODE>static&nbsp;void</CODE></FONT></TD>
174<TD><CODE><B><A HREF="NumbersFilter.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;argv)</CODE>
175
176<BR>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Main method for testing this class.</TD>
178</TR>
179<TR BGCOLOR="white" CLASS="TableRowColor">
180<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
181<CODE>&nbsp;boolean</CODE></FONT></TD>
182<TD><CODE><B><A HREF="NumbersFilter.html#setInputFormat(weka.core.Instances)">setInputFormat</A></B>(weka.core.Instances&nbsp;instanceInfo)</CODE>
183
184<BR>
185&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the format of the input instances.</TD>
186</TR>
187</TABLE>
188&nbsp;<A NAME="methods_inherited_from_class_weka.filters.Filter"><!-- --></A>
189<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
190<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
191<TD><B>Methods inherited from class weka.filters.Filter</B></TD>
192</TR>
193<TR BGCOLOR="white" CLASS="TableRowColor">
194<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>
195</TR>
196</TABLE>
197&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
198<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
199<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
200<TD><B>Methods inherited from class java.lang.Object</B></TD>
201</TR>
202<TR BGCOLOR="white" CLASS="TableRowColor">
203<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
204</TR>
205</TABLE>
206&nbsp;
207<P>
208
209<!-- ============ FIELD DETAIL =========== -->
210
211
212<!-- ========= CONSTRUCTOR DETAIL ======== -->
213
214<A NAME="constructor_detail"><!-- --></A>
215<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
216<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
217<TD COLSPAN=1><FONT SIZE="+2">
218<B>Constructor Detail</B></FONT></TD>
219</TR>
220</TABLE>
221
222<A NAME="NumbersFilter()"><!-- --></A><H3>
223NumbersFilter</H3>
224<PRE>
225public <B>NumbersFilter</B>()</PRE>
226<DL>
227</DL>
228
229<!-- ============ METHOD DETAIL ========== -->
230
231<A NAME="method_detail"><!-- --></A>
232<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
233<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
234<TD COLSPAN=1><FONT SIZE="+2">
235<B>Method Detail</B></FONT></TD>
236</TR>
237</TABLE>
238
239<A NAME="globalInfo()"><!-- --></A><H3>
240globalInfo</H3>
241<PRE>
242public java.lang.String <B>globalInfo</B>()</PRE>
243<DL>
244<DD>Returns a string describing this filter
245<P>
246<DD><DL>
247
248<DT><B>Returns:</B><DD>a description of the filter suitable for
249 displaying in the explorer/experimenter gui</DL>
250</DD>
251</DL>
252<HR>
253
254<A NAME="batchFinished()"><!-- --></A><H3>
255batchFinished</H3>
256<PRE>
257public boolean <B>batchFinished</B>()
258 throws java.lang.Exception</PRE>
259<DL>
260<DD>Signify that this batch of input to the filter is finished. If
261 the filter requires all instances prior to filtering, output()
262 may now be called to retrieve the filtered instances. Any
263 subsequent instances filtered should be filtered based on setting
264 obtained from the first batch (unless the inputFormat has been
265 re-assigned or new options have been set). This default
266 implementation assumes all instance processing occurs during
267 inputFormat() and input().
268<P>
269<DD><DL>
270<DT><B>Overrides:</B><DD><CODE>batchFinished</CODE> in class <CODE>weka.filters.Filter</CODE></DL>
271</DD>
272<DD><DL>
273
274<DT><B>Returns:</B><DD>true if there are instances pending output
275<DT><B>Throws:</B>
276<DD><CODE>java.lang.NullPointerException</CODE> - if no input structure has been defined,
277<DD><CODE>java.lang.Exception</CODE> - if there was a problem finishing the batch.</DL>
278</DD>
279</DL>
280<HR>
281
282<A NAME="setInputFormat(weka.core.Instances)"><!-- --></A><H3>
283setInputFormat</H3>
284<PRE>
285public boolean <B>setInputFormat</B>(weka.core.Instances&nbsp;instanceInfo)
286 throws java.lang.Exception</PRE>
287<DL>
288<DD>Sets the format of the input instances.
289<P>
290<DD><DL>
291<DT><B>Overrides:</B><DD><CODE>setInputFormat</CODE> in class <CODE>weka.filters.Filter</CODE></DL>
292</DD>
293<DD><DL>
294<DT><B>Parameters:</B><DD><CODE>instanceInfo</CODE> - an Instances object containing the input
295 instance structure (any instances contained in the object are
296 ignored - only the structure is required).
297<DT><B>Returns:</B><DD>true if the outputFormat may be collected immediately
298<DD><CODE>java.lang.Exception</CODE></DL>
299</DD>
300</DL>
301<HR>
302
303<A NAME="input(weka.core.Instance)"><!-- --></A><H3>
304input</H3>
305<PRE>
306public boolean <B>input</B>(weka.core.Instance&nbsp;instance)
307 throws java.lang.Exception</PRE>
308<DL>
309<DD>Input an instance for filtering. Ordinarily the instance is processed
310 and made available for output immediately. Some filters require all
311 instances be read before producing output.
312<P>
313<DD><DL>
314<DT><B>Overrides:</B><DD><CODE>input</CODE> in class <CODE>weka.filters.Filter</CODE></DL>
315</DD>
316<DD><DL>
317<DT><B>Parameters:</B><DD><CODE>instance</CODE> - the input instance
318<DT><B>Returns:</B><DD>true if the filtered instance may now be
319 collected with output().
320<DT><B>Throws:</B>
321<DD><CODE>java.lang.Exception</CODE> - if the input instance was not of the correct
322 format or if there was a problem with the filtering.</DL>
323</DD>
324</DL>
325<HR>
326
327<A NAME="main(java.lang.String[])"><!-- --></A><H3>
328main</H3>
329<PRE>
330public static void <B>main</B>(java.lang.String[]&nbsp;argv)</PRE>
331<DL>
332<DD>Main method for testing this class.
333<P>
334<DD><DL>
335<DT><B>Parameters:</B><DD><CODE>argv</CODE> - should contain arguments to the filter: use -h for help</DL>
336</DD>
337</DL>
338<!-- ========= END OF CLASS DATA ========= -->
339<HR>
340
341<!-- ========== START OF NAVBAR ========== -->
342<A NAME="navbar_bottom"><!-- --></A>
343<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
344<TR>
345<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
346<A NAME="navbar_bottom_firstrow"><!-- --></A>
347<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
348 <TR ALIGN="center" VALIGN="top">
349 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
350&nbsp;</TD>
351 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
352 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
353 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
354 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
355 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
356 </TR>
357</TABLE>
358</TD>
359<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
360</EM>
361</TD>
362</TR>
363
364<TR>
365<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
366&nbsp;<A HREF="LovinsStemmer.html"><B>PREV CLASS</B></A>&nbsp;
367&nbsp;<A HREF="Stemmer.html"><B>NEXT CLASS</B></A></FONT></TD>
368<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
369 <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A> &nbsp;
370&nbsp;<A HREF="NumbersFilter.html" TARGET="_top"><B>NO FRAMES</B></A> &nbsp;
371&nbsp;
372<SCRIPT>
373 <!--
374 if(window==top) {
375 document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
376 }
377 //-->
378</SCRIPT>
379<NOSCRIPT>
380<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
381</NOSCRIPT>
382</FONT></TD>
383</TR>
384<TR>
385<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
386 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_weka.filters.Filter">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
387<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
388DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
389</TR>
390</TABLE>
391<!-- =========== END OF NAVBAR =========== -->
392
393<HR>
394
395</BODY>
396</HTML>
Note: See TracBrowser for help on using the repository browser.