source: proiecte/HadoopJUnit/hadoop-0.20.1/docs/api/org/apache/hadoop/contrib/index/lucene/RAMDirectoryUtil.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: 15.2 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:59 UTC 2009 -->
6<TITLE>
7RAMDirectoryUtil (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="RAMDirectoryUtil (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/RAMDirectoryUtil.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/contrib/index/lucene/LuceneUtil.html" title="class in org.apache.hadoop.contrib.index.lucene"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../../org/apache/hadoop/contrib/index/lucene/ShardWriter.html" title="class in org.apache.hadoop.contrib.index.lucene"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../../index.html?org/apache/hadoop/contrib/index/lucene/RAMDirectoryUtil.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="RAMDirectoryUtil.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;FIELD&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;FIELD&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.contrib.index.lucene</FONT>
92<BR>
93Class RAMDirectoryUtil</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.contrib.index.lucene.RAMDirectoryUtil</B>
97</PRE>
98<HR>
99<DL>
100<DT><PRE>public class <B>RAMDirectoryUtil</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></DL>
101</PRE>
102
103<P>
104A utility class which writes an index in a ram dir into a DataOutput and
105 read from a DataInput an index into a ram dir.
106<P>
107
108<P>
109<HR>
110
111<P>
112
113<!-- ======== CONSTRUCTOR SUMMARY ======== -->
114
115<A NAME="constructor_summary"><!-- --></A>
116<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
117<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
118<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
119<B>Constructor Summary</B></FONT></TH>
120</TR>
121<TR BGCOLOR="white" CLASS="TableRowColor">
122<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/index/lucene/RAMDirectoryUtil.html#RAMDirectoryUtil()">RAMDirectoryUtil</A></B>()</CODE>
123
124<BR>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
126</TR>
127</TABLE>
128&nbsp;
129<!-- ========== METHOD SUMMARY =========== -->
130
131<A NAME="method_summary"><!-- --></A>
132<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
133<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
134<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
135<B>Method Summary</B></FONT></TH>
136</TR>
137<TR BGCOLOR="white" CLASS="TableRowColor">
138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139<CODE>static&nbsp;void</CODE></FONT></TD>
140<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/index/lucene/RAMDirectoryUtil.html#readRAMFiles(java.io.DataInput, org.apache.lucene.store.RAMDirectory)">readRAMFiles</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,
141             org.apache.lucene.store.RAMDirectory&nbsp;dir)</CODE>
142
143<BR>
144&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Read a number of files from a data input to a ram directory.</TD>
145</TR>
146<TR BGCOLOR="white" CLASS="TableRowColor">
147<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
148<CODE>static&nbsp;void</CODE></FONT></TD>
149<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/index/lucene/RAMDirectoryUtil.html#writeRAMFiles(java.io.DataOutput, org.apache.lucene.store.RAMDirectory, java.lang.String[])">writeRAMFiles</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,
150              org.apache.lucene.store.RAMDirectory&nbsp;dir,
151              <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]&nbsp;names)</CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Write a number of files from a ram directory to a data output.</TD>
155</TR>
156</TABLE>
157&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
158<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
159<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
160<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>
161</TR>
162<TR BGCOLOR="white" CLASS="TableRowColor">
163<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>
164</TR>
165</TABLE>
166&nbsp;
167<P>
168
169<!-- ========= CONSTRUCTOR DETAIL ======== -->
170
171<A NAME="constructor_detail"><!-- --></A>
172<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
173<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
174<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
175<B>Constructor Detail</B></FONT></TH>
176</TR>
177</TABLE>
178
179<A NAME="RAMDirectoryUtil()"><!-- --></A><H3>
180RAMDirectoryUtil</H3>
181<PRE>
182public <B>RAMDirectoryUtil</B>()</PRE>
183<DL>
184</DL>
185
186<!-- ============ METHOD DETAIL ========== -->
187
188<A NAME="method_detail"><!-- --></A>
189<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
190<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
191<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
192<B>Method Detail</B></FONT></TH>
193</TR>
194</TABLE>
195
196<A NAME="writeRAMFiles(java.io.DataOutput, org.apache.lucene.store.RAMDirectory, java.lang.String[])"><!-- --></A><H3>
197writeRAMFiles</H3>
198<PRE>
199public static void <B>writeRAMFiles</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,
200                                 org.apache.lucene.store.RAMDirectory&nbsp;dir,
201                                 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]&nbsp;names)
202                          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>
203<DL>
204<DD>Write a number of files from a ram directory to a data output.
205<P>
206<DD><DL>
207<DT><B>Parameters:</B><DD><CODE>out</CODE> - the data output<DD><CODE>dir</CODE> - the ram directory<DD><CODE>names</CODE> - the names of the files to write
208<DT><B>Throws:</B>
209<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>
210</DD>
211</DL>
212<HR>
213
214<A NAME="readRAMFiles(java.io.DataInput, org.apache.lucene.store.RAMDirectory)"><!-- --></A><H3>
215readRAMFiles</H3>
216<PRE>
217public static void <B>readRAMFiles</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,
218                                org.apache.lucene.store.RAMDirectory&nbsp;dir)
219                         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>
220<DL>
221<DD>Read a number of files from a data input to a ram directory.
222<P>
223<DD><DL>
224<DT><B>Parameters:</B><DD><CODE>in</CODE> - the data input<DD><CODE>dir</CODE> - the ram directory
225<DT><B>Throws:</B>
226<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>
227</DD>
228</DL>
229<!-- ========= END OF CLASS DATA ========= -->
230<HR>
231
232
233<!-- ======= START OF BOTTOM NAVBAR ====== -->
234<A NAME="navbar_bottom"><!-- --></A>
235<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
236<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
237<TR>
238<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
239<A NAME="navbar_bottom_firstrow"><!-- --></A>
240<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
241  <TR ALIGN="center" VALIGN="top">
242  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
243  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
244  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
245  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/RAMDirectoryUtil.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
246  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
247  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
248  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
249  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
250  </TR>
251</TABLE>
252</TD>
253<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
254</EM>
255</TD>
256</TR>
257
258<TR>
259<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
260&nbsp;<A HREF="../../../../../../org/apache/hadoop/contrib/index/lucene/LuceneUtil.html" title="class in org.apache.hadoop.contrib.index.lucene"><B>PREV CLASS</B></A>&nbsp;
261&nbsp;<A HREF="../../../../../../org/apache/hadoop/contrib/index/lucene/ShardWriter.html" title="class in org.apache.hadoop.contrib.index.lucene"><B>NEXT CLASS</B></A></FONT></TD>
262<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
263  <A HREF="../../../../../../index.html?org/apache/hadoop/contrib/index/lucene/RAMDirectoryUtil.html" target="_top"><B>FRAMES</B></A>  &nbsp;
264&nbsp;<A HREF="RAMDirectoryUtil.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
265&nbsp;<SCRIPT type="text/javascript">
266  <!--
267  if(window==top) {
268    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
269  }
270  //-->
271</SCRIPT>
272<NOSCRIPT>
273  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
274</NOSCRIPT>
275
276
277</FONT></TD>
278</TR>
279<TR>
280<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
281  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
282<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
283DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
284</TR>
285</TABLE>
286<A NAME="skip-navbar_bottom"></A>
287<!-- ======== END OF BOTTOM NAVBAR ======= -->
288
289<HR>
290Copyright &copy; 2009 The Apache Software Foundation
291</BODY>
292</HTML>
Note: See TracBrowser for help on using the repository browser.