source: proiecte/HadoopJUnit/hadoop-0.20.1/docs/api/org/apache/hadoop/util/bloom/Filter.html @ 120

Last change on this file since 120 was 120, checked in by (none), 14 years ago

Added the mail files for the Hadoop JUNit Project
  • Property svn:executable set to *
File size: 29.7 KB
Line 
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.6.0_07) on Tue Sep 01 20:56:55 UTC 2009 -->
6<TITLE>
7Filter (Hadoop 0.20.1 API)
8</TITLE>
9
10<META NAME="date" CONTENT="2009-09-01">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="Filter (Hadoop 0.20.1 API)";
19    }
20}
21</SCRIPT>
22<NOSCRIPT>
23</NOSCRIPT>
24
25</HEAD>
26
27<BODY BGCOLOR="white" onload="windowTitle();">
28<HR>
29
30
31<!-- ========= START OF TOP NAVBAR ======= -->
32<A NAME="navbar_top"><!-- --></A>
33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35<TR>
36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37<A NAME="navbar_top_firstrow"><!-- --></A>
38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39  <TR ALIGN="center" VALIGN="top">
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Filter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48  </TR>
49</TABLE>
50</TD>
51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52</EM>
53</TD>
54</TR>
55
56<TR>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58&nbsp;<A HREF="../../../../../org/apache/hadoop/util/bloom/DynamicBloomFilter.html" title="class in org.apache.hadoop.util.bloom"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/hadoop/util/bloom/HashFunction.html" title="class in org.apache.hadoop.util.bloom"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../index.html?org/apache/hadoop/util/bloom/Filter.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="Filter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<SCRIPT type="text/javascript">
64  <!--
65  if(window==top) {
66    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
67  }
68  //-->
69</SCRIPT>
70<NOSCRIPT>
71  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
72</NOSCRIPT>
73
74
75</FONT></TD>
76</TR>
77<TR>
78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79  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>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&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>
82</TR>
83</TABLE>
84<A NAME="skip-navbar_top"></A>
85<!-- ========= END OF TOP NAVBAR ========= -->
86
87<HR>
88<!-- ======== START OF CLASS DATA ======== -->
89<H2>
90<FONT SIZE="-1">
91org.apache.hadoop.util.bloom</FONT>
92<BR>
93Class Filter</H2>
94<PRE>
95<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
96  <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.hadoop.util.bloom.Filter</B>
97</PRE>
98<DL>
99<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A></DD>
100</DL>
101<DL>
102<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/hadoop/util/bloom/BloomFilter.html" title="class in org.apache.hadoop.util.bloom">BloomFilter</A>, <A HREF="../../../../../org/apache/hadoop/util/bloom/CountingBloomFilter.html" title="class in org.apache.hadoop.util.bloom">CountingBloomFilter</A>, <A HREF="../../../../../org/apache/hadoop/util/bloom/DynamicBloomFilter.html" title="class in org.apache.hadoop.util.bloom">DynamicBloomFilter</A></DD>
103</DL>
104<HR>
105<DL>
106<DT><PRE>public abstract class <B>Filter</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A></DL>
107</PRE>
108
109<P>
110Defines the general behavior of a filter.
111 <p>
112 A filter is a data structure which aims at offering a lossy summary of a set <code>A</code>.  The
113 key idea is to map entries of <code>A</code> (also called <i>keys</i>) into several positions
114 in a vector through the use of several hash functions.
115 <p>
116 Typically, a filter will be implemented as a Bloom filter (or a Bloom filter extension).
117 <p>
118 It must be extended in order to define the real behavior.
119<P>
120
121<P>
122<DL>
123<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/hadoop/util/bloom/Key.html" title="class in org.apache.hadoop.util.bloom"><CODE>The general behavior of a key</CODE></A>,
124<A HREF="../../../../../org/apache/hadoop/util/bloom/HashFunction.html" title="class in org.apache.hadoop.util.bloom"><CODE>A hash function</CODE></A></DL>
125<HR>
126
127<P>
128<!-- =========== FIELD SUMMARY =========== -->
129
130<A NAME="field_summary"><!-- --></A>
131<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
132<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
133<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
134<B>Field Summary</B></FONT></TH>
135</TR>
136<TR BGCOLOR="white" CLASS="TableRowColor">
137<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
138<CODE>protected &nbsp;<A HREF="../../../../../org/apache/hadoop/util/bloom/HashFunction.html" title="class in org.apache.hadoop.util.bloom">HashFunction</A></CODE></FONT></TD>
139<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html#hash">hash</A></B></CODE>
140
141<BR>
142&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The hash function used to map a key to several positions in the vector.</TD>
143</TR>
144<TR BGCOLOR="white" CLASS="TableRowColor">
145<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
146<CODE>protected &nbsp;int</CODE></FONT></TD>
147<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html#hashType">hashType</A></B></CODE>
148
149<BR>
150&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Type of hashing function to use.</TD>
151</TR>
152<TR BGCOLOR="white" CLASS="TableRowColor">
153<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
154<CODE>protected &nbsp;int</CODE></FONT></TD>
155<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html#nbHash">nbHash</A></B></CODE>
156
157<BR>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The number of hash function to consider.</TD>
159</TR>
160<TR BGCOLOR="white" CLASS="TableRowColor">
161<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
162<CODE>protected &nbsp;int</CODE></FONT></TD>
163<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html#vectorSize">vectorSize</A></B></CODE>
164
165<BR>
166&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The vector size of <i>this</i> filter.</TD>
167</TR>
168</TABLE>
169&nbsp;
170<!-- ======== CONSTRUCTOR SUMMARY ======== -->
171
172<A NAME="constructor_summary"><!-- --></A>
173<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
174<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
175<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
176<B>Constructor Summary</B></FONT></TH>
177</TR>
178<TR BGCOLOR="white" CLASS="TableRowColor">
179<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
180<CODE>protected </CODE></FONT></TD>
181<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html#Filter()">Filter</A></B>()</CODE>
182
183<BR>
184&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
185</TR>
186<TR BGCOLOR="white" CLASS="TableRowColor">
187<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188<CODE>protected </CODE></FONT></TD>
189<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html#Filter(int, int, int)">Filter</A></B>(int&nbsp;vectorSize,
190       int&nbsp;nbHash,
191       int&nbsp;hashType)</CODE>
192
193<BR>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor.</TD>
195</TR>
196</TABLE>
197&nbsp;
198<!-- ========== METHOD SUMMARY =========== -->
199
200<A NAME="method_summary"><!-- --></A>
201<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
202<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
203<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
204<B>Method Summary</B></FONT></TH>
205</TR>
206<TR BGCOLOR="white" CLASS="TableRowColor">
207<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
208<CODE>&nbsp;void</CODE></FONT></TD>
209<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html#add(java.util.Collection)">add</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../../org/apache/hadoop/util/bloom/Key.html" title="class in org.apache.hadoop.util.bloom">Key</A>&gt;&nbsp;keys)</CODE>
210
211<BR>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a collection of keys to <i>this</i> filter.</TD>
213</TR>
214<TR BGCOLOR="white" CLASS="TableRowColor">
215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216<CODE>abstract &nbsp;void</CODE></FONT></TD>
217<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html#add(org.apache.hadoop.util.bloom.Key)">add</A></B>(<A HREF="../../../../../org/apache/hadoop/util/bloom/Key.html" title="class in org.apache.hadoop.util.bloom">Key</A>&nbsp;key)</CODE>
218
219<BR>
220&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a key to <i>this</i> filter.</TD>
221</TR>
222<TR BGCOLOR="white" CLASS="TableRowColor">
223<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224<CODE>&nbsp;void</CODE></FONT></TD>
225<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html#add(org.apache.hadoop.util.bloom.Key[])">add</A></B>(<A HREF="../../../../../org/apache/hadoop/util/bloom/Key.html" title="class in org.apache.hadoop.util.bloom">Key</A>[]&nbsp;keys)</CODE>
226
227<BR>
228&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds an array of keys to <i>this</i> filter.</TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232<CODE>&nbsp;void</CODE></FONT></TD>
233<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html#add(java.util.List)">add</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../../org/apache/hadoop/util/bloom/Key.html" title="class in org.apache.hadoop.util.bloom">Key</A>&gt;&nbsp;keys)</CODE>
234
235<BR>
236&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a list of keys to <i>this</i> filter.</TD>
237</TR>
238<TR BGCOLOR="white" CLASS="TableRowColor">
239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240<CODE>abstract &nbsp;void</CODE></FONT></TD>
241<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html#and(org.apache.hadoop.util.bloom.Filter)">and</A></B>(<A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html" title="class in org.apache.hadoop.util.bloom">Filter</A>&nbsp;filter)</CODE>
242
243<BR>
244&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Peforms a logical AND between <i>this</i> filter and a specified filter.</TD>
245</TR>
246<TR BGCOLOR="white" CLASS="TableRowColor">
247<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
248<CODE>abstract &nbsp;boolean</CODE></FONT></TD>
249<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html#membershipTest(org.apache.hadoop.util.bloom.Key)">membershipTest</A></B>(<A HREF="../../../../../org/apache/hadoop/util/bloom/Key.html" title="class in org.apache.hadoop.util.bloom">Key</A>&nbsp;key)</CODE>
250
251<BR>
252&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines wether a specified key belongs to <i>this</i> filter.</TD>
253</TR>
254<TR BGCOLOR="white" CLASS="TableRowColor">
255<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
256<CODE>abstract &nbsp;void</CODE></FONT></TD>
257<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html#not()">not</A></B>()</CODE>
258
259<BR>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Performs a logical NOT on <i>this</i> filter.</TD>
261</TR>
262<TR BGCOLOR="white" CLASS="TableRowColor">
263<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264<CODE>abstract &nbsp;void</CODE></FONT></TD>
265<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html#or(org.apache.hadoop.util.bloom.Filter)">or</A></B>(<A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html" title="class in org.apache.hadoop.util.bloom">Filter</A>&nbsp;filter)</CODE>
266
267<BR>
268&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Peforms a logical OR between <i>this</i> filter and a specified filter.</TD>
269</TR>
270<TR BGCOLOR="white" CLASS="TableRowColor">
271<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
272<CODE>&nbsp;void</CODE></FONT></TD>
273<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html#readFields(java.io.DataInput)">readFields</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</A>&nbsp;in)</CODE>
274
275<BR>
276&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deserialize the fields of this object from <code>in</code>.</TD>
277</TR>
278<TR BGCOLOR="white" CLASS="TableRowColor">
279<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
280<CODE>&nbsp;void</CODE></FONT></TD>
281<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html#write(java.io.DataOutput)">write</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io">DataOutput</A>&nbsp;out)</CODE>
282
283<BR>
284&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Serialize the fields of this object to <code>out</code>.</TD>
285</TR>
286<TR BGCOLOR="white" CLASS="TableRowColor">
287<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
288<CODE>abstract &nbsp;void</CODE></FONT></TD>
289<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html#xor(org.apache.hadoop.util.bloom.Filter)">xor</A></B>(<A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html" title="class in org.apache.hadoop.util.bloom">Filter</A>&nbsp;filter)</CODE>
290
291<BR>
292&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Peforms a logical XOR between <i>this</i> filter and a specified filter.</TD>
293</TR>
294</TABLE>
295&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
296<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
297<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
298<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
299</TR>
300<TR BGCOLOR="white" CLASS="TableRowColor">
301<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
302</TR>
303</TABLE>
304&nbsp;
305<P>
306
307<!-- ============ FIELD DETAIL =========== -->
308
309<A NAME="field_detail"><!-- --></A>
310<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
311<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
312<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
313<B>Field Detail</B></FONT></TH>
314</TR>
315</TABLE>
316
317<A NAME="vectorSize"><!-- --></A><H3>
318vectorSize</H3>
319<PRE>
320protected int <B>vectorSize</B></PRE>
321<DL>
322<DD>The vector size of <i>this</i> filter.
323<P>
324<DL>
325</DL>
326</DL>
327<HR>
328
329<A NAME="hash"><!-- --></A><H3>
330hash</H3>
331<PRE>
332protected <A HREF="../../../../../org/apache/hadoop/util/bloom/HashFunction.html" title="class in org.apache.hadoop.util.bloom">HashFunction</A> <B>hash</B></PRE>
333<DL>
334<DD>The hash function used to map a key to several positions in the vector.
335<P>
336<DL>
337</DL>
338</DL>
339<HR>
340
341<A NAME="nbHash"><!-- --></A><H3>
342nbHash</H3>
343<PRE>
344protected int <B>nbHash</B></PRE>
345<DL>
346<DD>The number of hash function to consider.
347<P>
348<DL>
349</DL>
350</DL>
351<HR>
352
353<A NAME="hashType"><!-- --></A><H3>
354hashType</H3>
355<PRE>
356protected int <B>hashType</B></PRE>
357<DL>
358<DD>Type of hashing function to use.
359<P>
360<DL>
361</DL>
362</DL>
363
364<!-- ========= CONSTRUCTOR DETAIL ======== -->
365
366<A NAME="constructor_detail"><!-- --></A>
367<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
368<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
369<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
370<B>Constructor Detail</B></FONT></TH>
371</TR>
372</TABLE>
373
374<A NAME="Filter()"><!-- --></A><H3>
375Filter</H3>
376<PRE>
377protected <B>Filter</B>()</PRE>
378<DL>
379</DL>
380<HR>
381
382<A NAME="Filter(int, int, int)"><!-- --></A><H3>
383Filter</H3>
384<PRE>
385protected <B>Filter</B>(int&nbsp;vectorSize,
386                 int&nbsp;nbHash,
387                 int&nbsp;hashType)</PRE>
388<DL>
389<DD>Constructor.
390<P>
391<DL>
392<DT><B>Parameters:</B><DD><CODE>vectorSize</CODE> - The vector size of <i>this</i> filter.<DD><CODE>nbHash</CODE> - The number of hash functions to consider.<DD><CODE>hashType</CODE> - type of the hashing function (see <A HREF="../../../../../org/apache/hadoop/util/hash/Hash.html" title="class in org.apache.hadoop.util.hash"><CODE>Hash</CODE></A>).</DL>
393</DL>
394
395<!-- ============ METHOD DETAIL ========== -->
396
397<A NAME="method_detail"><!-- --></A>
398<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
399<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
400<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
401<B>Method Detail</B></FONT></TH>
402</TR>
403</TABLE>
404
405<A NAME="add(org.apache.hadoop.util.bloom.Key)"><!-- --></A><H3>
406add</H3>
407<PRE>
408public abstract void <B>add</B>(<A HREF="../../../../../org/apache/hadoop/util/bloom/Key.html" title="class in org.apache.hadoop.util.bloom">Key</A>&nbsp;key)</PRE>
409<DL>
410<DD>Adds a key to <i>this</i> filter.
411<P>
412<DD><DL>
413</DL>
414</DD>
415<DD><DL>
416<DT><B>Parameters:</B><DD><CODE>key</CODE> - The key to add.</DL>
417</DD>
418</DL>
419<HR>
420
421<A NAME="membershipTest(org.apache.hadoop.util.bloom.Key)"><!-- --></A><H3>
422membershipTest</H3>
423<PRE>
424public abstract boolean <B>membershipTest</B>(<A HREF="../../../../../org/apache/hadoop/util/bloom/Key.html" title="class in org.apache.hadoop.util.bloom">Key</A>&nbsp;key)</PRE>
425<DL>
426<DD>Determines wether a specified key belongs to <i>this</i> filter.
427<P>
428<DD><DL>
429</DL>
430</DD>
431<DD><DL>
432<DT><B>Parameters:</B><DD><CODE>key</CODE> - The key to test.
433<DT><B>Returns:</B><DD>boolean True if the specified key belongs to <i>this</i> filter.
434                     False otherwise.</DL>
435</DD>
436</DL>
437<HR>
438
439<A NAME="and(org.apache.hadoop.util.bloom.Filter)"><!-- --></A><H3>
440and</H3>
441<PRE>
442public abstract void <B>and</B>(<A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html" title="class in org.apache.hadoop.util.bloom">Filter</A>&nbsp;filter)</PRE>
443<DL>
444<DD>Peforms a logical AND between <i>this</i> filter and a specified filter.
445 <p>
446 <b>Invariant</b>: The result is assigned to <i>this</i> filter.
447<P>
448<DD><DL>
449</DL>
450</DD>
451<DD><DL>
452<DT><B>Parameters:</B><DD><CODE>filter</CODE> - The filter to AND with.</DL>
453</DD>
454</DL>
455<HR>
456
457<A NAME="or(org.apache.hadoop.util.bloom.Filter)"><!-- --></A><H3>
458or</H3>
459<PRE>
460public abstract void <B>or</B>(<A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html" title="class in org.apache.hadoop.util.bloom">Filter</A>&nbsp;filter)</PRE>
461<DL>
462<DD>Peforms a logical OR between <i>this</i> filter and a specified filter.
463 <p>
464 <b>Invariant</b>: The result is assigned to <i>this</i> filter.
465<P>
466<DD><DL>
467</DL>
468</DD>
469<DD><DL>
470<DT><B>Parameters:</B><DD><CODE>filter</CODE> - The filter to OR with.</DL>
471</DD>
472</DL>
473<HR>
474
475<A NAME="xor(org.apache.hadoop.util.bloom.Filter)"><!-- --></A><H3>
476xor</H3>
477<PRE>
478public abstract void <B>xor</B>(<A HREF="../../../../../org/apache/hadoop/util/bloom/Filter.html" title="class in org.apache.hadoop.util.bloom">Filter</A>&nbsp;filter)</PRE>
479<DL>
480<DD>Peforms a logical XOR between <i>this</i> filter and a specified filter.
481 <p>
482 <b>Invariant</b>: The result is assigned to <i>this</i> filter.
483<P>
484<DD><DL>
485</DL>
486</DD>
487<DD><DL>
488<DT><B>Parameters:</B><DD><CODE>filter</CODE> - The filter to XOR with.</DL>
489</DD>
490</DL>
491<HR>
492
493<A NAME="not()"><!-- --></A><H3>
494not</H3>
495<PRE>
496public abstract void <B>not</B>()</PRE>
497<DL>
498<DD>Performs a logical NOT on <i>this</i> filter.
499 <p>
500 The result is assigned to <i>this</i> filter.
501<P>
502<DD><DL>
503</DL>
504</DD>
505<DD><DL>
506</DL>
507</DD>
508</DL>
509<HR>
510
511<A NAME="add(java.util.List)"><!-- --></A><H3>
512add</H3>
513<PRE>
514public void <B>add</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../../org/apache/hadoop/util/bloom/Key.html" title="class in org.apache.hadoop.util.bloom">Key</A>&gt;&nbsp;keys)</PRE>
515<DL>
516<DD>Adds a list of keys to <i>this</i> filter.
517<P>
518<DD><DL>
519</DL>
520</DD>
521<DD><DL>
522<DT><B>Parameters:</B><DD><CODE>keys</CODE> - The list of keys.</DL>
523</DD>
524</DL>
525<HR>
526
527<A NAME="add(java.util.Collection)"><!-- --></A><H3>
528add</H3>
529<PRE>
530public void <B>add</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../../org/apache/hadoop/util/bloom/Key.html" title="class in org.apache.hadoop.util.bloom">Key</A>&gt;&nbsp;keys)</PRE>
531<DL>
532<DD>Adds a collection of keys to <i>this</i> filter.
533<P>
534<DD><DL>
535</DL>
536</DD>
537<DD><DL>
538<DT><B>Parameters:</B><DD><CODE>keys</CODE> - The collection of keys.</DL>
539</DD>
540</DL>
541<HR>
542
543<A NAME="add(org.apache.hadoop.util.bloom.Key[])"><!-- --></A><H3>
544add</H3>
545<PRE>
546public void <B>add</B>(<A HREF="../../../../../org/apache/hadoop/util/bloom/Key.html" title="class in org.apache.hadoop.util.bloom">Key</A>[]&nbsp;keys)</PRE>
547<DL>
548<DD>Adds an array of keys to <i>this</i> filter.
549<P>
550<DD><DL>
551</DL>
552</DD>
553<DD><DL>
554<DT><B>Parameters:</B><DD><CODE>keys</CODE> - The array of keys.</DL>
555</DD>
556</DL>
557<HR>
558
559<A NAME="write(java.io.DataOutput)"><!-- --></A><H3>
560write</H3>
561<PRE>
562public void <B>write</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io">DataOutput</A>&nbsp;out)
563           throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
564<DL>
565<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/hadoop/io/Writable.html#write(java.io.DataOutput)">Writable</A></CODE></B></DD>
566<DD>Serialize the fields of this object to <code>out</code>.
567<P>
568<DD><DL>
569<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/hadoop/io/Writable.html#write(java.io.DataOutput)">write</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A></CODE></DL>
570</DD>
571<DD><DL>
572<DT><B>Parameters:</B><DD><CODE>out</CODE> - <code>DataOuput</code> to serialize this object into.
573<DT><B>Throws:</B>
574<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
575</DD>
576</DL>
577<HR>
578
579<A NAME="readFields(java.io.DataInput)"><!-- --></A><H3>
580readFields</H3>
581<PRE>
582public void <B>readFields</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</A>&nbsp;in)
583                throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
584<DL>
585<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/hadoop/io/Writable.html#readFields(java.io.DataInput)">Writable</A></CODE></B></DD>
586<DD>Deserialize the fields of this object from <code>in</code>. 
587 
588 <p>For efficiency, implementations should attempt to re-use storage in the
589 existing object where possible.</p>
590<P>
591<DD><DL>
592<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/hadoop/io/Writable.html#readFields(java.io.DataInput)">readFields</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A></CODE></DL>
593</DD>
594<DD><DL>
595<DT><B>Parameters:</B><DD><CODE>in</CODE> - <code>DataInput</code> to deseriablize this object from.
596<DT><B>Throws:</B>
597<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
598</DD>
599</DL>
600<!-- ========= END OF CLASS DATA ========= -->
601<HR>
602
603
604<!-- ======= START OF BOTTOM NAVBAR ====== -->
605<A NAME="navbar_bottom"><!-- --></A>
606<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
607<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
608<TR>
609<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
610<A NAME="navbar_bottom_firstrow"><!-- --></A>
611<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
612  <TR ALIGN="center" VALIGN="top">
613  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
614  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
615  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
616  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Filter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
617  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
618  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
619  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
620  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
621  </TR>
622</TABLE>
623</TD>
624<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
625</EM>
626</TD>
627</TR>
628
629<TR>
630<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
631&nbsp;<A HREF="../../../../../org/apache/hadoop/util/bloom/DynamicBloomFilter.html" title="class in org.apache.hadoop.util.bloom"><B>PREV CLASS</B></A>&nbsp;
632&nbsp;<A HREF="../../../../../org/apache/hadoop/util/bloom/HashFunction.html" title="class in org.apache.hadoop.util.bloom"><B>NEXT CLASS</B></A></FONT></TD>
633<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
634  <A HREF="../../../../../index.html?org/apache/hadoop/util/bloom/Filter.html" target="_top"><B>FRAMES</B></A>  &nbsp;
635&nbsp;<A HREF="Filter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
636&nbsp;<SCRIPT type="text/javascript">
637  <!--
638  if(window==top) {
639    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
640  }
641  //-->
642</SCRIPT>
643<NOSCRIPT>
644  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
645</NOSCRIPT>
646
647
648</FONT></TD>
649</TR>
650<TR>
651<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
652  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>
653<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
654DETAIL:&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>
655</TR>
656</TABLE>
657<A NAME="skip-navbar_bottom"></A>
658<!-- ======== END OF BOTTOM NAVBAR ======= -->
659
660<HR>
661Copyright &copy; 2009 The Apache Software Foundation
662</BODY>
663</HTML>
Note: See TracBrowser for help on using the repository browser.