source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/search/CacheRegenerator.html @ 7588

Revision 7588, 11.7 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:25 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8CacheRegenerator (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="CacheRegenerator (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/CacheRegenerator.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/search/CacheConfig.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/search/DelegatingCollector.html" title="class in org.apache.solr.search"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../index.html?org/apache/solr/search/CacheRegenerator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="CacheRegenerator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<SCRIPT type="text/javascript">
64  <!--
65  if(window==top) {
66    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
67  }
68  //-->
69</SCRIPT>
70<NOSCRIPT>
71  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
72</NOSCRIPT>
73
74
75</FONT></TD>
76</TR>
77<TR>
78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&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.search</FONT>
92<BR>
93Interface CacheRegenerator</H2>
94<DL>
95<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.IdentityRegenerator.html" title="class in org.apache.solr.util">SolrPluginUtils.IdentityRegenerator</A></DD>
96</DL>
97<HR>
98<DL>
99<DT><PRE>public interface <B>CacheRegenerator</B></DL>
100</PRE>
101
102<P>
103Implementations of <code>CacheRegenerator</code> are used in autowarming to populate a new cache
104 based on an old cache.  <code>regenerateItem</code> is called for each item that should be inserted into the new cache.
105 <p>
106 Implementations should have a noarg constructor and be thread safe (a single instance will be
107 used for all cache autowarmings).
108<P>
109
110<P>
111<HR>
112
113<P>
114
115<!-- ========== METHOD SUMMARY =========== -->
116
117<A NAME="method_summary"><!-- --></A>
118<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
119<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
120<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
121<B>Method Summary</B></FONT></TH>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
125<CODE>&nbsp;boolean</CODE></FONT></TD>
126<TD><CODE><B><A HREF="../../../../org/apache/solr/search/CacheRegenerator.html#regenerateItem(org.apache.solr.search.SolrIndexSearcher, org.apache.solr.search.SolrCache, org.apache.solr.search.SolrCache, java.lang.Object, java.lang.Object)">regenerateItem</A></B>(<A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;newSearcher,
127               <A HREF="../../../../org/apache/solr/search/SolrCache.html" title="interface in org.apache.solr.search">SolrCache</A>&nbsp;newCache,
128               <A HREF="../../../../org/apache/solr/search/SolrCache.html" title="interface in org.apache.solr.search">SolrCache</A>&nbsp;oldCache,
129               <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;oldKey,
130               <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;oldVal)</CODE>
131
132<BR>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Regenerate an old cache item and insert it into <code>newCache</code></TD>
134</TR>
135</TABLE>
136&nbsp;
137<P>
138
139<!-- ============ METHOD DETAIL ========== -->
140
141<A NAME="method_detail"><!-- --></A>
142<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
143<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
144<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
145<B>Method Detail</B></FONT></TH>
146</TR>
147</TABLE>
148
149<A NAME="regenerateItem(org.apache.solr.search.SolrIndexSearcher, org.apache.solr.search.SolrCache, org.apache.solr.search.SolrCache, java.lang.Object, java.lang.Object)"><!-- --></A><H3>
150regenerateItem</H3>
151<PRE>
152boolean <B>regenerateItem</B>(<A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;newSearcher,
153                       <A HREF="../../../../org/apache/solr/search/SolrCache.html" title="interface in org.apache.solr.search">SolrCache</A>&nbsp;newCache,
154                       <A HREF="../../../../org/apache/solr/search/SolrCache.html" title="interface in org.apache.solr.search">SolrCache</A>&nbsp;oldCache,
155                       <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;oldKey,
156                       <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;oldVal)
157                       throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
158<DL>
159<DD>Regenerate an old cache item and insert it into <code>newCache</code>
160<P>
161<DD><DL>
162<DT><B>Parameters:</B><DD><CODE>newSearcher</CODE> - the new searcher who's caches are being autowarmed<DD><CODE>newCache</CODE> - where regenerated cache items should be stored. the target of the autowarming<DD><CODE>oldCache</CODE> - the old cache being used as a source for autowarming<DD><CODE>oldKey</CODE> - the key of the old cache item to regenerate in the new cache<DD><CODE>oldVal</CODE> - the old value of the cache item
163<DT><B>Returns:</B><DD>true to continue with autowarming, false to stop
164<DT><B>Throws:</B>
165<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
166</DD>
167</DL>
168<!-- ========= END OF CLASS DATA ========= -->
169<HR>
170
171
172<!-- ======= START OF BOTTOM NAVBAR ====== -->
173<A NAME="navbar_bottom"><!-- --></A>
174<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
175<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
176<TR>
177<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
178<A NAME="navbar_bottom_firstrow"><!-- --></A>
179<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
180  <TR ALIGN="center" VALIGN="top">
181  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
182  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
183  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
184  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/CacheRegenerator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
185  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
186  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
187  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
188  </TR>
189</TABLE>
190</TD>
191<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
192</EM>
193</TD>
194</TR>
195
196<TR>
197<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
198&nbsp;<A HREF="../../../../org/apache/solr/search/CacheConfig.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A>&nbsp;
199&nbsp;<A HREF="../../../../org/apache/solr/search/DelegatingCollector.html" title="class in org.apache.solr.search"><B>NEXT CLASS</B></A></FONT></TD>
200<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
201  <A HREF="../../../../index.html?org/apache/solr/search/CacheRegenerator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
202&nbsp;<A HREF="CacheRegenerator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
203&nbsp;<SCRIPT type="text/javascript">
204  <!--
205  if(window==top) {
206    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
207  }
208  //-->
209</SCRIPT>
210<NOSCRIPT>
211  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
212</NOSCRIPT>
213
214
215</FONT></TD>
216</TR>
217<TR>
218<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
219  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
220<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
221DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
222</TR>
223</TABLE>
224<A NAME="skip-navbar_bottom"></A>
225<!-- ======== END OF BOTTOM NAVBAR ======= -->
226
227<HR>
228
229          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
230          <script src='../../../../prettify.js' type='text/javascript'></script>
231          <script type='text/javascript'>
232            (function(){
233              var oldonload = window.onload;
234              if (typeof oldonload != 'function') {
235                window.onload = prettyPrint;
236              } else {
237                window.onload = function() {
238                  oldonload();
239                  prettyPrint();
240                }
241              }
242            })();
243          </script>
244       
245</BODY>
246</HTML>
Note: See TracBrowser for help on using the repository browser.