source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/core/SolrEventListener.html @ 7588

Revision 7588, 14.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:24 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8SolrEventListener (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="SolrEventListener (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/SolrEventListener.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/core/SolrDeletionPolicy.html" title="class in org.apache.solr.core"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../index.html?org/apache/solr/core/SolrEventListener.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="SolrEventListener.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;CONSTR&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;CONSTR&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.core</FONT>
92<BR>
93Interface SolrEventListener</H2>
94<DL>
95<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html" title="interface in org.apache.solr.util.plugin">NamedListInitializedPlugin</A></DD>
96</DL>
97<DL>
98<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/solr/core/AbstractSolrEventListener.html" title="class in org.apache.solr.core">AbstractSolrEventListener</A>, <A HREF="../../../../org/apache/solr/core/QuerySenderListener.html" title="class in org.apache.solr.core">QuerySenderListener</A></DD>
99</DL>
100<HR>
101<DL>
102<DT><PRE>public interface <B>SolrEventListener</B><DT>extends <A HREF="../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html" title="interface in org.apache.solr.util.plugin">NamedListInitializedPlugin</A></DL>
103</PRE>
104
105<P>
106<HR>
107
108<P>
109<!-- =========== FIELD SUMMARY =========== -->
110
111<A NAME="field_summary"><!-- --></A>
112<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
113<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
114<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
115<B>Field Summary</B></FONT></TH>
116</TR>
117<TR BGCOLOR="white" CLASS="TableRowColor">
118<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
119<CODE>static&nbsp;org.slf4j.Logger</CODE></FONT></TD>
120<TD><CODE><B><A HREF="../../../../org/apache/solr/core/SolrEventListener.html#log">log</A></B></CODE>
121
122<BR>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
124</TR>
125</TABLE>
126&nbsp;
127<!-- ========== METHOD SUMMARY =========== -->
128
129<A NAME="method_summary"><!-- --></A>
130<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
131<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
132<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
133<B>Method Summary</B></FONT></TH>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137<CODE>&nbsp;void</CODE></FONT></TD>
138<TD><CODE><B><A HREF="../../../../org/apache/solr/core/SolrEventListener.html#newSearcher(org.apache.solr.search.SolrIndexSearcher, org.apache.solr.search.SolrIndexSearcher)">newSearcher</A></B>(<A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;newSearcher,
139            <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;currentSearcher)</CODE>
140
141<BR>
142&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The searchers passed here are only guaranteed to be valid for the duration
143 of this method call, so care should be taken not to spawn threads or asynchronous
144 tasks with references to these searchers.</TD>
145</TR>
146<TR BGCOLOR="white" CLASS="TableRowColor">
147<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
148<CODE>&nbsp;void</CODE></FONT></TD>
149<TD><CODE><B><A HREF="../../../../org/apache/solr/core/SolrEventListener.html#postCommit()">postCommit</A></B>()</CODE>
150
151<BR>
152&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
156<CODE>&nbsp;void</CODE></FONT></TD>
157<TD><CODE><B><A HREF="../../../../org/apache/solr/core/SolrEventListener.html#postSoftCommit()">postSoftCommit</A></B>()</CODE>
158
159<BR>
160&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
161</TR>
162</TABLE>
163&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.util.plugin.NamedListInitializedPlugin"><!-- --></A>
164<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
165<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
166<TH ALIGN="left"><B>Methods inherited from interface org.apache.solr.util.plugin.<A HREF="../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html" title="interface in org.apache.solr.util.plugin">NamedListInitializedPlugin</A></B></TH>
167</TR>
168<TR BGCOLOR="white" CLASS="TableRowColor">
169<TD><CODE><A HREF="../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE></TD>
170</TR>
171</TABLE>
172&nbsp;
173<P>
174
175<!-- ============ FIELD DETAIL =========== -->
176
177<A NAME="field_detail"><!-- --></A>
178<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
179<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
180<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
181<B>Field Detail</B></FONT></TH>
182</TR>
183</TABLE>
184
185<A NAME="log"><!-- --></A><H3>
186log</H3>
187<PRE>
188static final org.slf4j.Logger <B>log</B></PRE>
189<DL>
190<DL>
191</DL>
192</DL>
193
194<!-- ============ METHOD DETAIL ========== -->
195
196<A NAME="method_detail"><!-- --></A>
197<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
198<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
199<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
200<B>Method Detail</B></FONT></TH>
201</TR>
202</TABLE>
203
204<A NAME="postCommit()"><!-- --></A><H3>
205postCommit</H3>
206<PRE>
207void <B>postCommit</B>()</PRE>
208<DL>
209<DD><DL>
210</DL>
211</DD>
212<DD><DL>
213</DL>
214</DD>
215</DL>
216<HR>
217
218<A NAME="postSoftCommit()"><!-- --></A><H3>
219postSoftCommit</H3>
220<PRE>
221void <B>postSoftCommit</B>()</PRE>
222<DL>
223<DD><DL>
224</DL>
225</DD>
226<DD><DL>
227</DL>
228</DD>
229</DL>
230<HR>
231
232<A NAME="newSearcher(org.apache.solr.search.SolrIndexSearcher, org.apache.solr.search.SolrIndexSearcher)"><!-- --></A><H3>
233newSearcher</H3>
234<PRE>
235void <B>newSearcher</B>(<A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;newSearcher,
236                 <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;currentSearcher)</PRE>
237<DL>
238<DD>The searchers passed here are only guaranteed to be valid for the duration
239 of this method call, so care should be taken not to spawn threads or asynchronous
240 tasks with references to these searchers.
241 <p/>
242 Implementations should add the <A HREF="../../../../org/apache/solr/common/params/EventParams.html#EVENT"><CODE>EventParams.EVENT</CODE></A> parameter and set it to a value of either:
243 <ul>
244 <li><A HREF="../../../../org/apache/solr/common/params/EventParams.html#FIRST_SEARCHER"><CODE>EventParams.FIRST_SEARCHER</CODE></A> - First Searcher event</li>
245 <li><A HREF="../../../../org/apache/solr/common/params/EventParams.html#NEW_SEARCHER"><CODE>EventParams.NEW_SEARCHER</CODE></A> - New Searcher event</li>
246 </ul>
247
248 Sample:
249 <pre>
250    if (currentSearcher != null) {
251      nlst.add(CommonParams.EVENT, CommonParams.NEW_SEARCHER);
252    } else {
253      nlst.add(CommonParams.EVENT, CommonParams.FIRST_SEARCHER);
254    }
255
256 </pre>
257<P>
258<DD><DL>
259</DL>
260</DD>
261<DD><DL>
262<DT><B>Parameters:</B><DD><CODE>newSearcher</CODE> - The new <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search"><CODE>SolrIndexSearcher</CODE></A> to use<DD><CODE>currentSearcher</CODE> - The existing <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search"><CODE>SolrIndexSearcher</CODE></A>.  null if this is a firstSearcher event.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/core/AbstractSolrEventListener.html#addEventParms(org.apache.solr.search.SolrIndexSearcher, org.apache.solr.common.util.NamedList)"><CODE>AbstractSolrEventListener.addEventParms(org.apache.solr.search.SolrIndexSearcher, org.apache.solr.common.util.NamedList)</CODE></A></DL>
263</DD>
264</DL>
265<!-- ========= END OF CLASS DATA ========= -->
266<HR>
267
268
269<!-- ======= START OF BOTTOM NAVBAR ====== -->
270<A NAME="navbar_bottom"><!-- --></A>
271<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
272<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
273<TR>
274<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
275<A NAME="navbar_bottom_firstrow"><!-- --></A>
276<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
277  <TR ALIGN="center" VALIGN="top">
278  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
279  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
280  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
281  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SolrEventListener.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
282  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
283  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
284  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
285  </TR>
286</TABLE>
287</TD>
288<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
289</EM>
290</TD>
291</TR>
292
293<TR>
294<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
295&nbsp;<A HREF="../../../../org/apache/solr/core/SolrDeletionPolicy.html" title="class in org.apache.solr.core"><B>PREV CLASS</B></A>&nbsp;
296&nbsp;<A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core"><B>NEXT CLASS</B></A></FONT></TD>
297<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
298  <A HREF="../../../../index.html?org/apache/solr/core/SolrEventListener.html" target="_top"><B>FRAMES</B></A>  &nbsp;
299&nbsp;<A HREF="SolrEventListener.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
300&nbsp;<SCRIPT type="text/javascript">
301  <!--
302  if(window==top) {
303    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
304  }
305  //-->
306</SCRIPT>
307<NOSCRIPT>
308  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
309</NOSCRIPT>
310
311
312</FONT></TD>
313</TR>
314<TR>
315<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
316  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
317<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
318DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
319</TR>
320</TABLE>
321<A NAME="skip-navbar_bottom"></A>
322<!-- ======== END OF BOTTOM NAVBAR ======= -->
323
324<HR>
325
326          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
327          <script src='../../../../prettify.js' type='text/javascript'></script>
328          <script type='text/javascript'>
329            (function(){
330              var oldonload = window.onload;
331              if (typeof oldonload != 'function') {
332                window.onload = prettyPrint;
333              } else {
334                window.onload = function() {
335                  oldonload();
336                  prettyPrint();
337                }
338              }
339            })();
340          </script>
341       
342</BODY>
343</HTML>
Note: See TracBrowser for help on using the repository browser.