source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/handler/dataimport/FileDataSource.html @ 7588

Revision 7588, 24.4 KB checked in by adir, 11 years ago (diff)

Ticket #000 - Adicionando a integracao de buscas com Solr na base a ser isnerida na comunidade
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_24) on Mon Jun 25 15:26:26 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8FileDataSource (Solr 4.0.0-ALPHA API)
9</TITLE>
10
11<META NAME="date" CONTENT="2012-06-25">
12
13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
14
15<SCRIPT type="text/javascript">
16function windowTitle()
17{
18    if (location.href.indexOf('is-external=true') == -1) {
19        parent.document.title="FileDataSource (Solr 4.0.0-ALPHA API)";
20    }
21}
22</SCRIPT>
23<NOSCRIPT>
24</NOSCRIPT>
25
26</HEAD>
27
28<BODY BGCOLOR="white" onload="windowTitle();">
29<HR>
30
31
32<!-- ========= START OF TOP NAVBAR ======= -->
33<A NAME="navbar_top"><!-- --></A>
34<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
36<TR>
37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38<A NAME="navbar_top_firstrow"><!-- --></A>
39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40  <TR ALIGN="center" VALIGN="top">
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
43  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FileDataSource.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</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/solr/handler/dataimport/FieldStreamDataSource.html" title="class in org.apache.solr.handler.dataimport"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/solr/handler/dataimport/FileListEntityProcessor.html" title="class in org.apache.solr.handler.dataimport"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../index.html?org/apache/solr/handler/dataimport/FileDataSource.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="FileDataSource.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.solr.handler.dataimport</FONT>
92<BR>
93Class FileDataSource</H2>
94<PRE>
95<A HREF="http://download.oracle.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 "><A HREF="../../../../../org/apache/solr/handler/dataimport/DataSource.html" title="class in org.apache.solr.handler.dataimport">org.apache.solr.handler.dataimport.DataSource</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A>&gt;
97      <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.handler.dataimport.FileDataSource</B>
98</PRE>
99<HR>
100<DL>
101<DT><PRE>public class <B>FileDataSource</B><DT>extends <A HREF="../../../../../org/apache/solr/handler/dataimport/DataSource.html" title="class in org.apache.solr.handler.dataimport">DataSource</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A>&gt;</DL>
102</PRE>
103
104<P>
105<p>
106 A <A HREF="../../../../../org/apache/solr/handler/dataimport/DataSource.html" title="class in org.apache.solr.handler.dataimport"><CODE>DataSource</CODE></A> which reads from local files
107 </p>
108 <p>
109 The file is read with the default platform encoding. It can be overriden by
110 specifying the encoding in solrconfig.xml
111 </p>
112 <p/>
113 <p>
114 Refer to <a
115 href="http://wiki.apache.org/solr/DataImportHandler">http://wiki.apache.org/solr/DataImportHandler</a>
116 for more details.
117 </p>
118 <p/>
119 <b>This API is experimental and may change in the future.</b>
120<P>
121
122<P>
123<DL>
124<DT><B>Since:</B></DT>
125  <DD>solr 1.3</DD>
126</DL>
127<HR>
128
129<P>
130<!-- =========== FIELD SUMMARY =========== -->
131
132<A NAME="field_summary"><!-- --></A>
133<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
134<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
135<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
136<B>Field Summary</B></FONT></TH>
137</TR>
138<TR BGCOLOR="white" CLASS="TableRowColor">
139<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
140<CODE>static&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
141<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/FileDataSource.html#BASE_PATH">BASE_PATH</A></B></CODE>
142
143<BR>
144&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
145</TR>
146<TR BGCOLOR="white" CLASS="TableRowColor">
147<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
148<CODE>protected &nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
149<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/FileDataSource.html#basePath">basePath</A></B></CODE>
150
151<BR>
152&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The basePath for this data source</TD>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
156<CODE>protected &nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
157<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/FileDataSource.html#encoding">encoding</A></B></CODE>
158
159<BR>
160&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The encoding using which the given file should be read</TD>
161</TR>
162</TABLE>
163&nbsp;
164<!-- ======== CONSTRUCTOR SUMMARY ======== -->
165
166<A NAME="constructor_summary"><!-- --></A>
167<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
168<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
169<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
170<B>Constructor Summary</B></FONT></TH>
171</TR>
172<TR BGCOLOR="white" CLASS="TableRowColor">
173<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/FileDataSource.html#FileDataSource()">FileDataSource</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" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
184<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
185<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
186<B>Method Summary</B></FONT></TH>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
190<CODE>&nbsp;void</CODE></FONT></TD>
191<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/FileDataSource.html#close()">close</A></B>()</CODE>
192
193<BR>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Cleans up resources of this DataSource after use.</TD>
195</TR>
196<TR BGCOLOR="white" CLASS="TableRowColor">
197<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
198<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A></CODE></FONT></TD>
199<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/FileDataSource.html#getData(java.lang.String)">getData</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;query)</CODE>
200
201<BR>
202&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
203 Returns a reader for the given file.</TD>
204</TR>
205<TR BGCOLOR="white" CLASS="TableRowColor">
206<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207<CODE>&nbsp;void</CODE></FONT></TD>
208<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/FileDataSource.html#init(org.apache.solr.handler.dataimport.Context, java.util.Properties)">init</A></B>(<A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html" title="class in org.apache.solr.handler.dataimport">Context</A>&nbsp;context,
209     <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A>&nbsp;initProps)</CODE>
210
211<BR>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initializes the DataSource with the <code>Context</code> and
213 initialization properties.</TD>
214</TR>
215<TR BGCOLOR="white" CLASS="TableRowColor">
216<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
217<CODE>protected &nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A></CODE></FONT></TD>
218<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/FileDataSource.html#openStream(java.io.File)">openStream</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>&nbsp;file)</CODE>
219
220<BR>
221&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Open a <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io"><CODE>Reader</CODE></A> for the given file name</TD>
222</TR>
223</TABLE>
224&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
225<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
226<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
227<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
228</TR>
229<TR BGCOLOR="white" CLASS="TableRowColor">
230<TD><CODE><A HREF="http://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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>
231</TR>
232</TABLE>
233&nbsp;
234<P>
235
236<!-- ============ FIELD DETAIL =========== -->
237
238<A NAME="field_detail"><!-- --></A>
239<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
240<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
241<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
242<B>Field Detail</B></FONT></TH>
243</TR>
244</TABLE>
245
246<A NAME="BASE_PATH"><!-- --></A><H3>
247BASE_PATH</H3>
248<PRE>
249public static final <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>BASE_PATH</B></PRE>
250<DL>
251<DL>
252<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.handler.dataimport.FileDataSource.BASE_PATH">Constant Field Values</A></DL>
253</DL>
254<HR>
255
256<A NAME="basePath"><!-- --></A><H3>
257basePath</H3>
258<PRE>
259protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>basePath</B></PRE>
260<DL>
261<DD>The basePath for this data source
262<P>
263<DL>
264</DL>
265</DL>
266<HR>
267
268<A NAME="encoding"><!-- --></A><H3>
269encoding</H3>
270<PRE>
271protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>encoding</B></PRE>
272<DL>
273<DD>The encoding using which the given file should be read
274<P>
275<DL>
276</DL>
277</DL>
278
279<!-- ========= CONSTRUCTOR DETAIL ======== -->
280
281<A NAME="constructor_detail"><!-- --></A>
282<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
283<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
284<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
285<B>Constructor Detail</B></FONT></TH>
286</TR>
287</TABLE>
288
289<A NAME="FileDataSource()"><!-- --></A><H3>
290FileDataSource</H3>
291<PRE>
292public <B>FileDataSource</B>()</PRE>
293<DL>
294</DL>
295
296<!-- ============ METHOD DETAIL ========== -->
297
298<A NAME="method_detail"><!-- --></A>
299<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
300<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
301<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
302<B>Method Detail</B></FONT></TH>
303</TR>
304</TABLE>
305
306<A NAME="init(org.apache.solr.handler.dataimport.Context, java.util.Properties)"><!-- --></A><H3>
307init</H3>
308<PRE>
309public void <B>init</B>(<A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html" title="class in org.apache.solr.handler.dataimport">Context</A>&nbsp;context,
310                 <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A>&nbsp;initProps)</PRE>
311<DL>
312<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/solr/handler/dataimport/DataSource.html#init(org.apache.solr.handler.dataimport.Context, java.util.Properties)">DataSource</A></CODE></B></DD>
313<DD>Initializes the DataSource with the <code>Context</code> and
314 initialization properties.
315 <p/>
316 This is invoked by the <code>DataImporter</code> after creating an
317 instance of this class.
318<P>
319<DD><DL>
320<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/dataimport/DataSource.html#init(org.apache.solr.handler.dataimport.Context, java.util.Properties)">init</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/dataimport/DataSource.html" title="class in org.apache.solr.handler.dataimport">DataSource</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A>&gt;</CODE></DL>
321</DD>
322<DD><DL>
323</DL>
324</DD>
325</DL>
326<HR>
327
328<A NAME="getData(java.lang.String)"><!-- --></A><H3>
329getData</H3>
330<PRE>
331public <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> <B>getData</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;query)</PRE>
332<DL>
333<DD><p>
334 Returns a reader for the given file.
335 </p>
336 <p>
337 If the given file is not absolute, we try to construct an absolute path
338 using basePath configuration. If that fails, then the relative path is
339 tried. If file is not found a RuntimeException is thrown.
340 </p>
341 <p>
342 <b>It is the responsibility of the calling method to properly close the
343 returned Reader</b>
344 </p>
345<P>
346<DD><DL>
347<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/dataimport/DataSource.html#getData(java.lang.String)">getData</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/dataimport/DataSource.html" title="class in org.apache.solr.handler.dataimport">DataSource</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A>&gt;</CODE></DL>
348</DD>
349<DD><DL>
350<DT><B>Parameters:</B><DD><CODE>query</CODE> - The query string. It can be a SQL for JdbcDataSource or a URL
351              for HttpDataSource or a file location for FileDataSource or a custom
352              format for your own custom DataSource.
353<DT><B>Returns:</B><DD>Depends on the implementation. For instance JdbcDataSource returns
354         an Iterator&lt;Map &lt;String,Object&gt;&gt;</DL>
355</DD>
356</DL>
357<HR>
358
359<A NAME="openStream(java.io.File)"><!-- --></A><H3>
360openStream</H3>
361<PRE>
362protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> <B>openStream</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>&nbsp;file)
363                     throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A>,
364                            <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/UnsupportedEncodingException.html?is-external=true" title="class or interface in java.io">UnsupportedEncodingException</A></PRE>
365<DL>
366<DD>Open a <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io"><CODE>Reader</CODE></A> for the given file name
367<P>
368<DD><DL>
369<DT><B>Parameters:</B><DD><CODE>file</CODE> - a <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><CODE>File</CODE></A> instance
370<DT><B>Returns:</B><DD>a Reader on the given file
371<DT><B>Throws:</B>
372<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></CODE> - if the File does not exist
373<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/UnsupportedEncodingException.html?is-external=true" title="class or interface in java.io">UnsupportedEncodingException</A></CODE> - if the encoding is unsupported<DT><B>Since:</B></DT>
374  <DD>solr 1.4</DD>
375</DL>
376</DD>
377</DL>
378<HR>
379
380<A NAME="close()"><!-- --></A><H3>
381close</H3>
382<PRE>
383public void <B>close</B>()</PRE>
384<DL>
385<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/solr/handler/dataimport/DataSource.html#close()">DataSource</A></CODE></B></DD>
386<DD>Cleans up resources of this DataSource after use.
387<P>
388<DD><DL>
389<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/dataimport/DataSource.html#close()">close</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/dataimport/DataSource.html" title="class in org.apache.solr.handler.dataimport">DataSource</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A>&gt;</CODE></DL>
390</DD>
391<DD><DL>
392</DL>
393</DD>
394</DL>
395<!-- ========= END OF CLASS DATA ========= -->
396<HR>
397
398
399<!-- ======= START OF BOTTOM NAVBAR ====== -->
400<A NAME="navbar_bottom"><!-- --></A>
401<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
402<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
403<TR>
404<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
405<A NAME="navbar_bottom_firstrow"><!-- --></A>
406<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
407  <TR ALIGN="center" VALIGN="top">
408  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
409  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
410  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
411  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FileDataSource.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
412  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
413  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
414  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
415  </TR>
416</TABLE>
417</TD>
418<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
419</EM>
420</TD>
421</TR>
422
423<TR>
424<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
425&nbsp;<A HREF="../../../../../org/apache/solr/handler/dataimport/FieldStreamDataSource.html" title="class in org.apache.solr.handler.dataimport"><B>PREV CLASS</B></A>&nbsp;
426&nbsp;<A HREF="../../../../../org/apache/solr/handler/dataimport/FileListEntityProcessor.html" title="class in org.apache.solr.handler.dataimport"><B>NEXT CLASS</B></A></FONT></TD>
427<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
428  <A HREF="../../../../../index.html?org/apache/solr/handler/dataimport/FileDataSource.html" target="_top"><B>FRAMES</B></A>  &nbsp;
429&nbsp;<A HREF="FileDataSource.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
430&nbsp;<SCRIPT type="text/javascript">
431  <!--
432  if(window==top) {
433    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
434  }
435  //-->
436</SCRIPT>
437<NOSCRIPT>
438  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
439</NOSCRIPT>
440
441
442</FONT></TD>
443</TR>
444<TR>
445<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
446  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>
447<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
448DETAIL:&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>
449</TR>
450</TABLE>
451<A NAME="skip-navbar_bottom"></A>
452<!-- ======== END OF BOTTOM NAVBAR ======= -->
453
454<HR>
455
456          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
457          <script src='../../../../../prettify.js' type='text/javascript'></script>
458          <script type='text/javascript'>
459            (function(){
460              var oldonload = window.onload;
461              if (typeof oldonload != 'function') {
462                window.onload = prettyPrint;
463              } else {
464                window.onload = function() {
465                  oldonload();
466                  prettyPrint();
467                }
468              }
469            })();
470          </script>
471       
472</BODY>
473</HTML>
Note: See TracBrowser for help on using the repository browser.