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

Revision 7588, 47.5 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>
8Context (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="Context (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/Context.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/ContentStreamDataSource.html" title="class in org.apache.solr.handler.dataimport"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/solr/handler/dataimport/ContextImpl.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/Context.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="Context.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 Context</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 "><B>org.apache.solr.handler.dataimport.Context</B>
97</PRE>
98<DL>
99<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/solr/handler/dataimport/ContextImpl.html" title="class in org.apache.solr.handler.dataimport">ContextImpl</A></DD>
100</DL>
101<HR>
102<DL>
103<DT><PRE>public abstract class <B>Context</B><DT>extends <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></DL>
104</PRE>
105
106<P>
107<p>
108 This abstract class gives access to all available objects. So any
109 component implemented by a user can have the full power of DataImportHandler
110 </p>
111 <p>
112 Refer to <a
113 href="http://wiki.apache.org/solr/DataImportHandler">http://wiki.apache.org/solr/DataImportHandler</a>
114 for more details.
115 </p>
116 <p/>
117 <b>This API is experimental and subject to change</b>
118<P>
119
120<P>
121<DL>
122<DT><B>Since:</B></DT>
123  <DD>solr 1.3</DD>
124</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>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>
139<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#DELTA_DUMP">DELTA_DUMP</A></B></CODE>
140
141<BR>
142&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
143</TR>
144<TR BGCOLOR="white" CLASS="TableRowColor">
145<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
146<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>
147<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#FIND_DELTA">FIND_DELTA</A></B></CODE>
148
149<BR>
150&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
151</TR>
152<TR BGCOLOR="white" CLASS="TableRowColor">
153<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
154<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>
155<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#FULL_DUMP">FULL_DUMP</A></B></CODE>
156
157<BR>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
159</TR>
160<TR BGCOLOR="white" CLASS="TableRowColor">
161<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
162<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>
163<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#SCOPE_DOC">SCOPE_DOC</A></B></CODE>
164
165<BR>
166&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;An object stored in document scope is available for the current document only but across entities.</TD>
167</TR>
168<TR BGCOLOR="white" CLASS="TableRowColor">
169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170<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>
171<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#SCOPE_ENTITY">SCOPE_ENTITY</A></B></CODE>
172
173<BR>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;An object stored in entity scope is valid only for the current entity for the current document only.</TD>
175</TR>
176<TR BGCOLOR="white" CLASS="TableRowColor">
177<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
178<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>
179<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#SCOPE_GLOBAL">SCOPE_GLOBAL</A></B></CODE>
180
181<BR>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;An object stored in global scope is available for the current import only but across entities and documents.</TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186<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>
187<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#SCOPE_SOLR_CORE">SCOPE_SOLR_CORE</A></B></CODE>
188
189<BR>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;An object stored in 'solrcore' scope is available across imports, entities and documents throughout the life of
191 a solr core.</TD>
192</TR>
193</TABLE>
194&nbsp;
195<!-- ======== CONSTRUCTOR SUMMARY ======== -->
196
197<A NAME="constructor_summary"><!-- --></A>
198<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
199<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
200<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
201<B>Constructor Summary</B></FONT></TH>
202</TR>
203<TR BGCOLOR="white" CLASS="TableRowColor">
204<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#Context()">Context</A></B>()</CODE>
205
206<BR>
207&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
208</TR>
209</TABLE>
210&nbsp;
211<!-- ========== METHOD SUMMARY =========== -->
212
213<A NAME="method_summary"><!-- --></A>
214<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
215<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
216<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
217<B>Method Summary</B></FONT></TH>
218</TR>
219<TR BGCOLOR="white" CLASS="TableRowColor">
220<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
221<CODE>abstract &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>
222<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#currentProcess()">currentProcess</A></B>()</CODE>
223
224<BR>
225&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the current process FULL_DUMP, DELTA_DUMP, FIND_DELTA</TD>
226</TR>
227<TR BGCOLOR="white" CLASS="TableRowColor">
228<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
229<CODE>abstract &nbsp;void</CODE></FONT></TD>
230<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#deleteDoc(java.lang.String)">deleteDoc</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;id)</CODE>
231
232<BR>
233&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;delete a document by id</TD>
234</TR>
235<TR BGCOLOR="white" CLASS="TableRowColor">
236<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
237<CODE>abstract &nbsp;void</CODE></FONT></TD>
238<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#deleteDocByQuery(java.lang.String)">deleteDocByQuery</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>
239
240<BR>
241&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;delete documents by query</TD>
242</TR>
243<TR BGCOLOR="white" CLASS="TableRowColor">
244<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
245<CODE>abstract &nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<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>,<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>&gt;&gt;</CODE></FONT></TD>
246<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#getAllEntityFields()">getAllEntityFields</A></B>()</CODE>
247
248<BR>
249&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns all the fields put into an entity.</TD>
250</TR>
251<TR BGCOLOR="white" CLASS="TableRowColor">
252<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
253<CODE>abstract &nbsp;<A HREF="../../../../../org/apache/solr/handler/dataimport/DataSource.html" title="class in org.apache.solr.handler.dataimport">DataSource</A></CODE></FONT></TD>
254<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#getDataSource()">getDataSource</A></B>()</CODE>
255
256<BR>
257&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the datasource instance defined for this entity.</TD>
258</TR>
259<TR BGCOLOR="white" CLASS="TableRowColor">
260<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
261<CODE>abstract &nbsp;<A HREF="../../../../../org/apache/solr/handler/dataimport/DataSource.html" title="class in org.apache.solr.handler.dataimport">DataSource</A></CODE></FONT></TD>
262<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#getDataSource(java.lang.String)">getDataSource</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;name)</CODE>
263
264<BR>
265&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets a new DataSource instance with a name.</TD>
266</TR>
267<TR BGCOLOR="white" CLASS="TableRowColor">
268<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
269<CODE>abstract &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>
270<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#getEntityAttribute(java.lang.String)">getEntityAttribute</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;name)</CODE>
271
272<BR>
273&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of any attribute put into this entity</TD>
274</TR>
275<TR BGCOLOR="white" CLASS="TableRowColor">
276<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
277<CODE>abstract &nbsp;<A HREF="../../../../../org/apache/solr/handler/dataimport/EntityProcessor.html" title="class in org.apache.solr.handler.dataimport">EntityProcessor</A></CODE></FONT></TD>
278<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#getEntityProcessor()">getEntityProcessor</A></B>()</CODE>
279
280<BR>
281&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the instance of EntityProcessor used for this entity</TD>
282</TR>
283<TR BGCOLOR="white" CLASS="TableRowColor">
284<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
285<CODE>abstract &nbsp;<A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html" title="class in org.apache.solr.handler.dataimport">Context</A></CODE></FONT></TD>
286<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#getParentContext()">getParentContext</A></B>()</CODE>
287
288<BR>
289&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the context instance for the parent entity.</TD>
290</TR>
291<TR BGCOLOR="white" CLASS="TableRowColor">
292<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
293<CODE>abstract &nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<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>,<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>&gt;</CODE></FONT></TD>
294<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#getRequestParameters()">getRequestParameters</A></B>()</CODE>
295
296<BR>
297&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The request parameters passed over HTTP for this command the values in the
298 map are either String(for single valued parameters) or List<String> (for
299 multi-valued parameters)</TD>
300</TR>
301<TR BGCOLOR="white" CLASS="TableRowColor">
302<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
303<CODE>abstract &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>
304<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#getResolvedEntityAttribute(java.lang.String)">getResolvedEntityAttribute</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;name)</CODE>
305
306<BR>
307&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of any attribute put into this entity after resolving all variables found in the attribute value</TD>
308</TR>
309<TR BGCOLOR="white" CLASS="TableRowColor">
310<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
311<CODE>abstract &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>
312<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#getScript()">getScript</A></B>()</CODE>
313
314<BR>
315&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the text specified in the script tag in the data-config.xml</TD>
316</TR>
317<TR BGCOLOR="white" CLASS="TableRowColor">
318<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
319<CODE>abstract &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>
320<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#getScriptLanguage()">getScriptLanguage</A></B>()</CODE>
321
322<BR>
323&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the language of the script as specified in the script tag in data-config.xml</TD>
324</TR>
325<TR BGCOLOR="white" CLASS="TableRowColor">
326<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
327<CODE>abstract &nbsp;<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></CODE></FONT></TD>
328<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#getSessionAttribute(java.lang.String, java.lang.String)">getSessionAttribute</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;name,
329                    <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;scope)</CODE>
330
331<BR>
332&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;get a value by name in the given scope (entity, document,global)</TD>
333</TR>
334<TR BGCOLOR="white" CLASS="TableRowColor">
335<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
336<CODE>abstract &nbsp;<A HREF="../../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A></CODE></FONT></TD>
337<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#getSolrCore()">getSolrCore</A></B>()</CODE>
338
339<BR>
340&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Exposing the actual SolrCore to the components</TD>
341</TR>
342<TR BGCOLOR="white" CLASS="TableRowColor">
343<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
344<CODE>abstract &nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<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>,<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>&gt;</CODE></FONT></TD>
345<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#getStats()">getStats</A></B>()</CODE>
346
347<BR>
348&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Makes available some basic running statistics such as "docCount",
349 "deletedDocCount", "rowCount", "queryCount" and "skipDocCount"</TD>
350</TR>
351<TR BGCOLOR="white" CLASS="TableRowColor">
352<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
353<CODE>abstract &nbsp;<A HREF="../../../../../org/apache/solr/handler/dataimport/VariableResolver.html" title="class in org.apache.solr.handler.dataimport">VariableResolver</A></CODE></FONT></TD>
354<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#getVariableResolver()">getVariableResolver</A></B>()</CODE>
355
356<BR>
357&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the VariableResolver used in this entity which can be used to
358 resolve the tokens in ${<namespce.name>}</TD>
359</TR>
360<TR BGCOLOR="white" CLASS="TableRowColor">
361<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
362<CODE>abstract &nbsp;boolean</CODE></FONT></TD>
363<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#isRootEntity()">isRootEntity</A></B>()</CODE>
364
365<BR>
366&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns if the current entity is the root entity</TD>
367</TR>
368<TR BGCOLOR="white" CLASS="TableRowColor">
369<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
370<CODE>abstract &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>
371<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#replaceTokens(java.lang.String)">replaceTokens</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;template)</CODE>
372
373<BR>
374&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Resolve variables in a template</TD>
375</TR>
376<TR BGCOLOR="white" CLASS="TableRowColor">
377<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
378<CODE>abstract &nbsp;<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></CODE></FONT></TD>
379<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#resolve(java.lang.String)">resolve</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;var)</CODE>
380
381<BR>
382&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Use this directly to  resolve variable</TD>
383</TR>
384<TR BGCOLOR="white" CLASS="TableRowColor">
385<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
386<CODE>abstract &nbsp;void</CODE></FONT></TD>
387<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#setSessionAttribute(java.lang.String, java.lang.Object, java.lang.String)">setSessionAttribute</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;name,
388                    <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>&nbsp;val,
389                    <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;scope)</CODE>
390
391<BR>
392&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Store values in a certain name and scope (entity, document,global)</TD>
393</TR>
394</TABLE>
395&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
396<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
397<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
398<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>
399</TR>
400<TR BGCOLOR="white" CLASS="TableRowColor">
401<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>
402</TR>
403</TABLE>
404&nbsp;
405<P>
406
407<!-- ============ FIELD DETAIL =========== -->
408
409<A NAME="field_detail"><!-- --></A>
410<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
411<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
412<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
413<B>Field Detail</B></FONT></TH>
414</TR>
415</TABLE>
416
417<A NAME="FULL_DUMP"><!-- --></A><H3>
418FULL_DUMP</H3>
419<PRE>
420public 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>FULL_DUMP</B></PRE>
421<DL>
422<DL>
423<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.handler.dataimport.Context.FULL_DUMP">Constant Field Values</A></DL>
424</DL>
425<HR>
426
427<A NAME="DELTA_DUMP"><!-- --></A><H3>
428DELTA_DUMP</H3>
429<PRE>
430public 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>DELTA_DUMP</B></PRE>
431<DL>
432<DL>
433<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.handler.dataimport.Context.DELTA_DUMP">Constant Field Values</A></DL>
434</DL>
435<HR>
436
437<A NAME="FIND_DELTA"><!-- --></A><H3>
438FIND_DELTA</H3>
439<PRE>
440public 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>FIND_DELTA</B></PRE>
441<DL>
442<DL>
443<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.handler.dataimport.Context.FIND_DELTA">Constant Field Values</A></DL>
444</DL>
445<HR>
446
447<A NAME="SCOPE_ENTITY"><!-- --></A><H3>
448SCOPE_ENTITY</H3>
449<PRE>
450public 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>SCOPE_ENTITY</B></PRE>
451<DL>
452<DD>An object stored in entity scope is valid only for the current entity for the current document only.
453<P>
454<DL>
455<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.handler.dataimport.Context.SCOPE_ENTITY">Constant Field Values</A></DL>
456</DL>
457<HR>
458
459<A NAME="SCOPE_GLOBAL"><!-- --></A><H3>
460SCOPE_GLOBAL</H3>
461<PRE>
462public 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>SCOPE_GLOBAL</B></PRE>
463<DL>
464<DD>An object stored in global scope is available for the current import only but across entities and documents.
465<P>
466<DL>
467<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.handler.dataimport.Context.SCOPE_GLOBAL">Constant Field Values</A></DL>
468</DL>
469<HR>
470
471<A NAME="SCOPE_DOC"><!-- --></A><H3>
472SCOPE_DOC</H3>
473<PRE>
474public 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>SCOPE_DOC</B></PRE>
475<DL>
476<DD>An object stored in document scope is available for the current document only but across entities.
477<P>
478<DL>
479<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.handler.dataimport.Context.SCOPE_DOC">Constant Field Values</A></DL>
480</DL>
481<HR>
482
483<A NAME="SCOPE_SOLR_CORE"><!-- --></A><H3>
484SCOPE_SOLR_CORE</H3>
485<PRE>
486public 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>SCOPE_SOLR_CORE</B></PRE>
487<DL>
488<DD>An object stored in 'solrcore' scope is available across imports, entities and documents throughout the life of
489 a solr core. A solr core unload or reload will destroy this data.
490<P>
491<DL>
492<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.handler.dataimport.Context.SCOPE_SOLR_CORE">Constant Field Values</A></DL>
493</DL>
494
495<!-- ========= CONSTRUCTOR DETAIL ======== -->
496
497<A NAME="constructor_detail"><!-- --></A>
498<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
499<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
500<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
501<B>Constructor Detail</B></FONT></TH>
502</TR>
503</TABLE>
504
505<A NAME="Context()"><!-- --></A><H3>
506Context</H3>
507<PRE>
508public <B>Context</B>()</PRE>
509<DL>
510</DL>
511
512<!-- ============ METHOD DETAIL ========== -->
513
514<A NAME="method_detail"><!-- --></A>
515<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
516<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
517<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
518<B>Method Detail</B></FONT></TH>
519</TR>
520</TABLE>
521
522<A NAME="getEntityAttribute(java.lang.String)"><!-- --></A><H3>
523getEntityAttribute</H3>
524<PRE>
525public abstract <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>getEntityAttribute</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;name)</PRE>
526<DL>
527<DD>Get the value of any attribute put into this entity
528<P>
529<DD><DL>
530<DT><B>Parameters:</B><DD><CODE>name</CODE> - name of the attribute eg: 'name'
531<DT><B>Returns:</B><DD>value of named attribute in entity</DL>
532</DD>
533</DL>
534<HR>
535
536<A NAME="getResolvedEntityAttribute(java.lang.String)"><!-- --></A><H3>
537getResolvedEntityAttribute</H3>
538<PRE>
539public abstract <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>getResolvedEntityAttribute</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;name)</PRE>
540<DL>
541<DD>Get the value of any attribute put into this entity after resolving all variables found in the attribute value
542<P>
543<DD><DL>
544<DT><B>Parameters:</B><DD><CODE>name</CODE> - name of the attribute
545<DT><B>Returns:</B><DD>value of the named attribute after resolving all variables</DL>
546</DD>
547</DL>
548<HR>
549
550<A NAME="getAllEntityFields()"><!-- --></A><H3>
551getAllEntityFields</H3>
552<PRE>
553public abstract <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<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>,<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>&gt;&gt; <B>getAllEntityFields</B>()</PRE>
554<DL>
555<DD>Returns all the fields put into an entity. each item (which is a map ) in
556 the list corresponds to one field. each if the map contains the attribute
557 names and values in a field
558<P>
559<DD><DL>
560
561<DT><B>Returns:</B><DD>all fields in an entity</DL>
562</DD>
563</DL>
564<HR>
565
566<A NAME="getVariableResolver()"><!-- --></A><H3>
567getVariableResolver</H3>
568<PRE>
569public abstract <A HREF="../../../../../org/apache/solr/handler/dataimport/VariableResolver.html" title="class in org.apache.solr.handler.dataimport">VariableResolver</A> <B>getVariableResolver</B>()</PRE>
570<DL>
571<DD>Returns the VariableResolver used in this entity which can be used to
572 resolve the tokens in ${<namespce.name>}
573<P>
574<DD><DL>
575
576<DT><B>Returns:</B><DD>a VariableResolver instance<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/solr/handler/dataimport/VariableResolver.html" title="class in org.apache.solr.handler.dataimport"><CODE>VariableResolver</CODE></A></DL>
577</DD>
578</DL>
579<HR>
580
581<A NAME="getDataSource()"><!-- --></A><H3>
582getDataSource</H3>
583<PRE>
584public abstract <A HREF="../../../../../org/apache/solr/handler/dataimport/DataSource.html" title="class in org.apache.solr.handler.dataimport">DataSource</A> <B>getDataSource</B>()</PRE>
585<DL>
586<DD>Gets the datasource instance defined for this entity. Do not close() this instance.
587 Transformers should use the getDataSource(String name) method.
588<P>
589<DD><DL>
590
591<DT><B>Returns:</B><DD>a new DataSource instance as configured for the current entity<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/solr/handler/dataimport/DataSource.html" title="class in org.apache.solr.handler.dataimport"><CODE>DataSource</CODE></A>,
592<A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html#getDataSource(java.lang.String)"><CODE>getDataSource(String)</CODE></A></DL>
593</DD>
594</DL>
595<HR>
596
597<A NAME="getDataSource(java.lang.String)"><!-- --></A><H3>
598getDataSource</H3>
599<PRE>
600public abstract <A HREF="../../../../../org/apache/solr/handler/dataimport/DataSource.html" title="class in org.apache.solr.handler.dataimport">DataSource</A> <B>getDataSource</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;name)</PRE>
601<DL>
602<DD>Gets a new DataSource instance with a name. Ensure that you close() this after use
603 because this is created just for this method call.
604<P>
605<DD><DL>
606<DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the dataSource as defined in the dataSource tag
607<DT><B>Returns:</B><DD>a new DataSource instance<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/solr/handler/dataimport/DataSource.html" title="class in org.apache.solr.handler.dataimport"><CODE>DataSource</CODE></A></DL>
608</DD>
609</DL>
610<HR>
611
612<A NAME="getEntityProcessor()"><!-- --></A><H3>
613getEntityProcessor</H3>
614<PRE>
615public abstract <A HREF="../../../../../org/apache/solr/handler/dataimport/EntityProcessor.html" title="class in org.apache.solr.handler.dataimport">EntityProcessor</A> <B>getEntityProcessor</B>()</PRE>
616<DL>
617<DD>Returns the instance of EntityProcessor used for this entity
618<P>
619<DD><DL>
620
621<DT><B>Returns:</B><DD>instance of EntityProcessor used for the current entity<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/solr/handler/dataimport/EntityProcessor.html" title="class in org.apache.solr.handler.dataimport"><CODE>EntityProcessor</CODE></A></DL>
622</DD>
623</DL>
624<HR>
625
626<A NAME="setSessionAttribute(java.lang.String, java.lang.Object, java.lang.String)"><!-- --></A><H3>
627setSessionAttribute</H3>
628<PRE>
629public abstract void <B>setSessionAttribute</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;name,
630                                         <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>&nbsp;val,
631                                         <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;scope)</PRE>
632<DL>
633<DD>Store values in a certain name and scope (entity, document,global)
634<P>
635<DD><DL>
636<DT><B>Parameters:</B><DD><CODE>name</CODE> - the key<DD><CODE>val</CODE> - the value<DD><CODE>scope</CODE> - the scope in which the given key, value pair is to be stored</DL>
637</DD>
638</DL>
639<HR>
640
641<A NAME="getSessionAttribute(java.lang.String, java.lang.String)"><!-- --></A><H3>
642getSessionAttribute</H3>
643<PRE>
644public abstract <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>getSessionAttribute</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;name,
645                                           <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;scope)</PRE>
646<DL>
647<DD>get a value by name in the given scope (entity, document,global)
648<P>
649<DD><DL>
650<DT><B>Parameters:</B><DD><CODE>name</CODE> - the key<DD><CODE>scope</CODE> - the scope from which the value is to be retreived
651<DT><B>Returns:</B><DD>the object stored in the given scope with the given key</DL>
652</DD>
653</DL>
654<HR>
655
656<A NAME="getParentContext()"><!-- --></A><H3>
657getParentContext</H3>
658<PRE>
659public abstract <A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html" title="class in org.apache.solr.handler.dataimport">Context</A> <B>getParentContext</B>()</PRE>
660<DL>
661<DD>Get the context instance for the parent entity. works only in the full dump
662 If the current entity is rootmost a null is returned
663<P>
664<DD><DL>
665
666<DT><B>Returns:</B><DD>parent entity's Context</DL>
667</DD>
668</DL>
669<HR>
670
671<A NAME="getRequestParameters()"><!-- --></A><H3>
672getRequestParameters</H3>
673<PRE>
674public abstract <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<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>,<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>&gt; <B>getRequestParameters</B>()</PRE>
675<DL>
676<DD>The request parameters passed over HTTP for this command the values in the
677 map are either String(for single valued parameters) or List<String> (for
678 multi-valued parameters)
679<P>
680<DD><DL>
681
682<DT><B>Returns:</B><DD>the request parameters passed in the URL to initiate this process</DL>
683</DD>
684</DL>
685<HR>
686
687<A NAME="isRootEntity()"><!-- --></A><H3>
688isRootEntity</H3>
689<PRE>
690public abstract boolean <B>isRootEntity</B>()</PRE>
691<DL>
692<DD>Returns if the current entity is the root entity
693<P>
694<DD><DL>
695
696<DT><B>Returns:</B><DD>true if current entity is the root entity, false otherwise</DL>
697</DD>
698</DL>
699<HR>
700
701<A NAME="currentProcess()"><!-- --></A><H3>
702currentProcess</H3>
703<PRE>
704public abstract <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>currentProcess</B>()</PRE>
705<DL>
706<DD>Returns the current process FULL_DUMP, DELTA_DUMP, FIND_DELTA
707<P>
708<DD><DL>
709
710<DT><B>Returns:</B><DD>the type of the current running process</DL>
711</DD>
712</DL>
713<HR>
714
715<A NAME="getSolrCore()"><!-- --></A><H3>
716getSolrCore</H3>
717<PRE>
718public abstract <A HREF="../../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A> <B>getSolrCore</B>()</PRE>
719<DL>
720<DD>Exposing the actual SolrCore to the components
721<P>
722<DD><DL>
723
724<DT><B>Returns:</B><DD>the core</DL>
725</DD>
726</DL>
727<HR>
728
729<A NAME="getStats()"><!-- --></A><H3>
730getStats</H3>
731<PRE>
732public abstract <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<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>,<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>&gt; <B>getStats</B>()</PRE>
733<DL>
734<DD>Makes available some basic running statistics such as "docCount",
735 "deletedDocCount", "rowCount", "queryCount" and "skipDocCount"
736<P>
737<DD><DL>
738
739<DT><B>Returns:</B><DD>a Map containing running statistics of the current import</DL>
740</DD>
741</DL>
742<HR>
743
744<A NAME="getScript()"><!-- --></A><H3>
745getScript</H3>
746<PRE>
747public abstract <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>getScript</B>()</PRE>
748<DL>
749<DD>Returns the text specified in the script tag in the data-config.xml
750<P>
751<DD><DL>
752</DL>
753</DD>
754</DL>
755<HR>
756
757<A NAME="getScriptLanguage()"><!-- --></A><H3>
758getScriptLanguage</H3>
759<PRE>
760public abstract <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>getScriptLanguage</B>()</PRE>
761<DL>
762<DD>Returns the language of the script as specified in the script tag in data-config.xml
763<P>
764<DD><DL>
765</DL>
766</DD>
767</DL>
768<HR>
769
770<A NAME="deleteDoc(java.lang.String)"><!-- --></A><H3>
771deleteDoc</H3>
772<PRE>
773public abstract void <B>deleteDoc</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;id)</PRE>
774<DL>
775<DD>delete a document by id
776<P>
777<DD><DL>
778<DT><B>Parameters:</B><DD><CODE>id</CODE> - </DL>
779</DD>
780</DL>
781<HR>
782
783<A NAME="deleteDocByQuery(java.lang.String)"><!-- --></A><H3>
784deleteDocByQuery</H3>
785<PRE>
786public abstract void <B>deleteDocByQuery</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>
787<DL>
788<DD>delete documents by query
789<P>
790<DD><DL>
791<DT><B>Parameters:</B><DD><CODE>query</CODE> - </DL>
792</DD>
793</DL>
794<HR>
795
796<A NAME="resolve(java.lang.String)"><!-- --></A><H3>
797resolve</H3>
798<PRE>
799public abstract <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>resolve</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;var)</PRE>
800<DL>
801<DD>Use this directly to  resolve variable
802<P>
803<DD><DL>
804<DT><B>Parameters:</B><DD><CODE>var</CODE> - the variable neme
805<DT><B>Returns:</B><DD>the resolved value</DL>
806</DD>
807</DL>
808<HR>
809
810<A NAME="replaceTokens(java.lang.String)"><!-- --></A><H3>
811replaceTokens</H3>
812<PRE>
813public abstract <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>replaceTokens</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;template)</PRE>
814<DL>
815<DD>Resolve variables in a template
816<P>
817<DD><DL>
818<DT><B>Parameters:</B><DD><CODE>template</CODE> -
819<DT><B>Returns:</B><DD>The string w/ variables resolved</DL>
820</DD>
821</DL>
822<!-- ========= END OF CLASS DATA ========= -->
823<HR>
824
825
826<!-- ======= START OF BOTTOM NAVBAR ====== -->
827<A NAME="navbar_bottom"><!-- --></A>
828<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
829<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
830<TR>
831<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
832<A NAME="navbar_bottom_firstrow"><!-- --></A>
833<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
834  <TR ALIGN="center" VALIGN="top">
835  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
836  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
837  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
838  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Context.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
839  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
840  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
841  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
842  </TR>
843</TABLE>
844</TD>
845<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
846</EM>
847</TD>
848</TR>
849
850<TR>
851<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
852&nbsp;<A HREF="../../../../../org/apache/solr/handler/dataimport/ContentStreamDataSource.html" title="class in org.apache.solr.handler.dataimport"><B>PREV CLASS</B></A>&nbsp;
853&nbsp;<A HREF="../../../../../org/apache/solr/handler/dataimport/ContextImpl.html" title="class in org.apache.solr.handler.dataimport"><B>NEXT CLASS</B></A></FONT></TD>
854<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
855  <A HREF="../../../../../index.html?org/apache/solr/handler/dataimport/Context.html" target="_top"><B>FRAMES</B></A>  &nbsp;
856&nbsp;<A HREF="Context.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
857&nbsp;<SCRIPT type="text/javascript">
858  <!--
859  if(window==top) {
860    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
861  }
862  //-->
863</SCRIPT>
864<NOSCRIPT>
865  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
866</NOSCRIPT>
867
868
869</FONT></TD>
870</TR>
871<TR>
872<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
873  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>
874<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
875DETAIL:&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>
876</TR>
877</TABLE>
878<A NAME="skip-navbar_bottom"></A>
879<!-- ======== END OF BOTTOM NAVBAR ======= -->
880
881<HR>
882
883          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
884          <script src='../../../../../prettify.js' type='text/javascript'></script>
885          <script type='text/javascript'>
886            (function(){
887              var oldonload = window.onload;
888              if (typeof oldonload != 'function') {
889                window.onload = prettyPrint;
890              } else {
891                window.onload = function() {
892                  oldonload();
893                  prettyPrint();
894                }
895              }
896            })();
897          </script>
898       
899</BODY>
900</HTML>
Note: See TracBrowser for help on using the repository browser.