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

Revision 7588, 24.1 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>
8SolrCache (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="SolrCache (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/SolrCache.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/ReturnFields.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/search/SolrCache.State.html" title="enum 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/SolrCache.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="SolrCache.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;<A HREF="#nested_class_summary">NESTED</A>&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.search</FONT>
92<BR>
93Interface SolrCache&lt;K,V&gt;</H2>
94<DL>
95<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></DD>
96</DL>
97<DL>
98<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/solr/search/FastLRUCache.html" title="class in org.apache.solr.search">FastLRUCache</A>, <A HREF="../../../../org/apache/solr/search/LFUCache.html" title="class in org.apache.solr.search">LFUCache</A>, <A HREF="../../../../org/apache/solr/search/LRUCache.html" title="class in org.apache.solr.search">LRUCache</A></DD>
99</DL>
100<HR>
101<DL>
102<DT><PRE>public interface <B>SolrCache&lt;K,V&gt;</B><DT>extends <A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></DL>
103</PRE>
104
105<P>
106Primary API for dealing with Solr's internal caches.
107<P>
108
109<P>
110<HR>
111
112<P>
113<!-- ======== NESTED CLASS SUMMARY ======== -->
114
115<A NAME="nested_class_summary"><!-- --></A>
116<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
117<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
118<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
119<B>Nested Class Summary</B></FONT></TH>
120</TR>
121<TR BGCOLOR="white" CLASS="TableRowColor">
122<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
123<CODE>static&nbsp;class</CODE></FONT></TD>
124<TD><CODE><B><A HREF="../../../../org/apache/solr/search/SolrCache.State.html" title="enum in org.apache.solr.search">SolrCache.State</A></B></CODE>
125
126<BR>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Enumeration of possible States for cache instances.</TD>
128</TR>
129</TABLE>
130&nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A>
131<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
132<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
133<TH ALIGN="left"><B>Nested classes/interfaces inherited from interface org.apache.solr.core.<A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></B></TH>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A></CODE></TD>
137</TR>
138</TABLE>
139&nbsp;
140<!-- =========== FIELD SUMMARY =========== -->
141
142<A NAME="field_summary"><!-- --></A>
143<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
144<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
145<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
146<B>Field Summary</B></FONT></TH>
147</TR>
148<TR BGCOLOR="white" CLASS="TableRowColor">
149<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150<CODE>static&nbsp;org.slf4j.Logger</CODE></FONT></TD>
151<TD><CODE><B><A HREF="../../../../org/apache/solr/search/SolrCache.html#log">log</A></B></CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
155</TR>
156</TABLE>
157&nbsp;
158<!-- ========== METHOD SUMMARY =========== -->
159
160<A NAME="method_summary"><!-- --></A>
161<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
162<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
163<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
164<B>Method Summary</B></FONT></TH>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168<CODE>&nbsp;void</CODE></FONT></TD>
169<TD><CODE><B><A HREF="../../../../org/apache/solr/search/SolrCache.html#clear()">clear</A></B>()</CODE>
170
171<BR>
172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;:TODO: copy from Map</TD>
173</TR>
174<TR BGCOLOR="white" CLASS="TableRowColor">
175<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
176<CODE>&nbsp;void</CODE></FONT></TD>
177<TD><CODE><B><A HREF="../../../../org/apache/solr/search/SolrCache.html#close()">close</A></B>()</CODE>
178
179<BR>
180&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Frees any non-memory resources</TD>
181</TR>
182<TR BGCOLOR="white" CLASS="TableRowColor">
183<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184<CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/SolrCache.html" title="type parameter in SolrCache">V</A></CODE></FONT></TD>
185<TD><CODE><B><A HREF="../../../../org/apache/solr/search/SolrCache.html#get(K)">get</A></B>(<A HREF="../../../../org/apache/solr/search/SolrCache.html" title="type parameter in SolrCache">K</A>&nbsp;key)</CODE>
186
187<BR>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;:TODO: copy from Map</TD>
189</TR>
190<TR BGCOLOR="white" CLASS="TableRowColor">
191<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
192<CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/SolrCache.State.html" title="enum in org.apache.solr.search">SolrCache.State</A></CODE></FONT></TD>
193<TD><CODE><B><A HREF="../../../../org/apache/solr/search/SolrCache.html#getState()">getState</A></B>()</CODE>
194
195<BR>
196&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the last State set on this instance</TD>
197</TR>
198<TR BGCOLOR="white" CLASS="TableRowColor">
199<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
200<CODE>&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>
201<TD><CODE><B><A HREF="../../../../org/apache/solr/search/SolrCache.html#init(java.util.Map, java.lang.Object, org.apache.solr.search.CacheRegenerator)">init</A></B>(<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>&nbsp;args,
202     <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;persistence,
203     <A HREF="../../../../org/apache/solr/search/CacheRegenerator.html" title="interface in org.apache.solr.search">CacheRegenerator</A>&nbsp;regenerator)</CODE>
204
205<BR>
206&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The initialization routine.</TD>
207</TR>
208<TR BGCOLOR="white" CLASS="TableRowColor">
209<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
210<CODE>&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>
211<TD><CODE><B><A HREF="../../../../org/apache/solr/search/SolrCache.html#name()">name</A></B>()</CODE>
212
213<BR>
214&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Name the Cache can be referenced with by SolrRequestHandlers.</TD>
215</TR>
216<TR BGCOLOR="white" CLASS="TableRowColor">
217<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
218<CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/SolrCache.html" title="type parameter in SolrCache">V</A></CODE></FONT></TD>
219<TD><CODE><B><A HREF="../../../../org/apache/solr/search/SolrCache.html#put(K, V)">put</A></B>(<A HREF="../../../../org/apache/solr/search/SolrCache.html" title="type parameter in SolrCache">K</A>&nbsp;key,
220    <A HREF="../../../../org/apache/solr/search/SolrCache.html" title="type parameter in SolrCache">V</A>&nbsp;value)</CODE>
221
222<BR>
223&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;:TODO: copy from Map</TD>
224</TR>
225<TR BGCOLOR="white" CLASS="TableRowColor">
226<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
227<CODE>&nbsp;void</CODE></FONT></TD>
228<TD><CODE><B><A HREF="../../../../org/apache/solr/search/SolrCache.html#setState(org.apache.solr.search.SolrCache.State)">setState</A></B>(<A HREF="../../../../org/apache/solr/search/SolrCache.State.html" title="enum in org.apache.solr.search">SolrCache.State</A>&nbsp;state)</CODE>
229
230<BR>
231&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set different cache states.</TD>
232</TR>
233<TR BGCOLOR="white" CLASS="TableRowColor">
234<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
235<CODE>&nbsp;int</CODE></FONT></TD>
236<TD><CODE><B><A HREF="../../../../org/apache/solr/search/SolrCache.html#size()">size</A></B>()</CODE>
237
238<BR>
239&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;:TODO: copy from Map</TD>
240</TR>
241<TR BGCOLOR="white" CLASS="TableRowColor">
242<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
243<CODE>&nbsp;void</CODE></FONT></TD>
244<TD><CODE><B><A HREF="../../../../org/apache/solr/search/SolrCache.html#warm(org.apache.solr.search.SolrIndexSearcher, org.apache.solr.search.SolrCache)">warm</A></B>(<A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;searcher,
245     <A HREF="../../../../org/apache/solr/search/SolrCache.html" title="interface in org.apache.solr.search">SolrCache</A>&lt;<A HREF="../../../../org/apache/solr/search/SolrCache.html" title="type parameter in SolrCache">K</A>,<A HREF="../../../../org/apache/solr/search/SolrCache.html" title="type parameter in SolrCache">V</A>&gt;&nbsp;old)</CODE>
246
247<BR>
248&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Warm this cache associated with <code>searcher</code> using the <code>old</code>
249 cache object.</TD>
250</TR>
251</TABLE>
252&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A>
253<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
254<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
255<TH ALIGN="left"><B>Methods inherited from interface org.apache.solr.core.<A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></B></TH>
256</TR>
257<TR BGCOLOR="white" CLASS="TableRowColor">
258<TD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getCategory()">getCategory</A>, <A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">getDescription</A>, <A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getDocs()">getDocs</A>, <A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getName()">getName</A>, <A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">getSource</A>, <A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getStatistics()">getStatistics</A>, <A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getVersion()">getVersion</A></CODE></TD>
259</TR>
260</TABLE>
261&nbsp;
262<P>
263
264<!-- ============ FIELD DETAIL =========== -->
265
266<A NAME="field_detail"><!-- --></A>
267<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
268<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
269<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
270<B>Field Detail</B></FONT></TH>
271</TR>
272</TABLE>
273
274<A NAME="log"><!-- --></A><H3>
275log</H3>
276<PRE>
277static final org.slf4j.Logger <B>log</B></PRE>
278<DL>
279<DL>
280</DL>
281</DL>
282
283<!-- ============ METHOD DETAIL ========== -->
284
285<A NAME="method_detail"><!-- --></A>
286<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
287<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
288<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
289<B>Method Detail</B></FONT></TH>
290</TR>
291</TABLE>
292
293<A NAME="init(java.util.Map, java.lang.Object, org.apache.solr.search.CacheRegenerator)"><!-- --></A><H3>
294init</H3>
295<PRE>
296<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>init</B>(<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>&nbsp;args,
297            <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;persistence,
298            <A HREF="../../../../org/apache/solr/search/CacheRegenerator.html" title="interface in org.apache.solr.search">CacheRegenerator</A>&nbsp;regenerator)</PRE>
299<DL>
300<DD>The initialization routine.  Instance specific arguments are passed in
301 the <code>args</code> map.
302 <p>
303 The persistence object will exist across different lifetimes of similar caches.
304 For example, all filter caches will share the same persistence object, sometimes
305 at the same time (it must be threadsafe).  If null is passed, then the cache
306 implementation should create and return a new persistence object.  If not null,
307 the passed in object should be returned again.
308 <p>
309 Since it will exist across the lifetime of many caches, care should be taken to
310 not reference any particular cache instance and prevent it from being
311 garbage collected (no using inner classes unless they are static).
312 <p>
313 The persistence object is designed to be used as a way for statistics
314 to accumulate across all instances of the same type of cache, however the
315 object may be of any type desired by the cache implementation.
316 <p>
317 The <A HREF="../../../../org/apache/solr/search/CacheRegenerator.html" title="interface in org.apache.solr.search"><CODE>CacheRegenerator</CODE></A> is what the cache uses during auto-warming to
318 renenerate an item in the new cache from an entry in the old cache.
319<P>
320<DD><DL>
321</DL>
322</DD>
323<DD><DL>
324</DL>
325</DD>
326</DL>
327<HR>
328
329<A NAME="name()"><!-- --></A><H3>
330name</H3>
331<PRE>
332<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>name</B>()</PRE>
333<DL>
334<DD>Name the Cache can be referenced with by SolrRequestHandlers.
335
336 This method must return the identifier that the Cache instance
337 expects SolrRequestHandlers to use when requesting access to it
338 from the SolrIndexSearcher.  It is <strong>strongly</strong>
339 recommended that this method return the value of the "name"
340 parameter from the init args.
341
342 :TODO: verify this.
343<P>
344<DD><DL>
345</DL>
346</DD>
347<DD><DL>
348</DL>
349</DD>
350</DL>
351<HR>
352
353<A NAME="size()"><!-- --></A><H3>
354size</H3>
355<PRE>
356int <B>size</B>()</PRE>
357<DL>
358<DD>:TODO: copy from Map
359<P>
360<DD><DL>
361</DL>
362</DD>
363<DD><DL>
364</DL>
365</DD>
366</DL>
367<HR>
368
369<A NAME="put(java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="put(K, V)"><!-- --></A><H3>
370put</H3>
371<PRE>
372<A HREF="../../../../org/apache/solr/search/SolrCache.html" title="type parameter in SolrCache">V</A> <B>put</B>(<A HREF="../../../../org/apache/solr/search/SolrCache.html" title="type parameter in SolrCache">K</A>&nbsp;key,
373      <A HREF="../../../../org/apache/solr/search/SolrCache.html" title="type parameter in SolrCache">V</A>&nbsp;value)</PRE>
374<DL>
375<DD>:TODO: copy from Map
376<P>
377<DD><DL>
378</DL>
379</DD>
380<DD><DL>
381</DL>
382</DD>
383</DL>
384<HR>
385
386<A NAME="get(java.lang.Object)"><!-- --></A><A NAME="get(K)"><!-- --></A><H3>
387get</H3>
388<PRE>
389<A HREF="../../../../org/apache/solr/search/SolrCache.html" title="type parameter in SolrCache">V</A> <B>get</B>(<A HREF="../../../../org/apache/solr/search/SolrCache.html" title="type parameter in SolrCache">K</A>&nbsp;key)</PRE>
390<DL>
391<DD>:TODO: copy from Map
392<P>
393<DD><DL>
394</DL>
395</DD>
396<DD><DL>
397</DL>
398</DD>
399</DL>
400<HR>
401
402<A NAME="clear()"><!-- --></A><H3>
403clear</H3>
404<PRE>
405void <B>clear</B>()</PRE>
406<DL>
407<DD>:TODO: copy from Map
408<P>
409<DD><DL>
410</DL>
411</DD>
412<DD><DL>
413</DL>
414</DD>
415</DL>
416<HR>
417
418<A NAME="setState(org.apache.solr.search.SolrCache.State)"><!-- --></A><H3>
419setState</H3>
420<PRE>
421void <B>setState</B>(<A HREF="../../../../org/apache/solr/search/SolrCache.State.html" title="enum in org.apache.solr.search">SolrCache.State</A>&nbsp;state)</PRE>
422<DL>
423<DD>Set different cache states.
424 The state a cache is in can have an effect on how statistics are kept.
425 The cache user (SolrIndexSearcher) will take care of switching
426 cache states.
427<P>
428<DD><DL>
429</DL>
430</DD>
431<DD><DL>
432</DL>
433</DD>
434</DL>
435<HR>
436
437<A NAME="getState()"><!-- --></A><H3>
438getState</H3>
439<PRE>
440<A HREF="../../../../org/apache/solr/search/SolrCache.State.html" title="enum in org.apache.solr.search">SolrCache.State</A> <B>getState</B>()</PRE>
441<DL>
442<DD>Returns the last State set on this instance
443<P>
444<DD><DL>
445</DL>
446</DD>
447<DD><DL>
448<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/search/SolrCache.html#setState(org.apache.solr.search.SolrCache.State)"><CODE>setState(org.apache.solr.search.SolrCache.State)</CODE></A></DL>
449</DD>
450</DL>
451<HR>
452
453<A NAME="warm(org.apache.solr.search.SolrIndexSearcher, org.apache.solr.search.SolrCache)"><!-- --></A><H3>
454warm</H3>
455<PRE>
456void <B>warm</B>(<A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;searcher,
457          <A HREF="../../../../org/apache/solr/search/SolrCache.html" title="interface in org.apache.solr.search">SolrCache</A>&lt;<A HREF="../../../../org/apache/solr/search/SolrCache.html" title="type parameter in SolrCache">K</A>,<A HREF="../../../../org/apache/solr/search/SolrCache.html" title="type parameter in SolrCache">V</A>&gt;&nbsp;old)
458          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>
459<DL>
460<DD>Warm this cache associated with <code>searcher</code> using the <code>old</code>
461 cache object.  <code>this</code> and <code>old</code> will have the same concrete type.
462<P>
463<DD><DL>
464</DL>
465</DD>
466<DD><DL>
467
468<DT><B>Throws:</B>
469<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>
470</DD>
471</DL>
472<HR>
473
474<A NAME="close()"><!-- --></A><H3>
475close</H3>
476<PRE>
477void <B>close</B>()</PRE>
478<DL>
479<DD>Frees any non-memory resources
480<P>
481<DD><DL>
482</DL>
483</DD>
484<DD><DL>
485</DL>
486</DD>
487</DL>
488<!-- ========= END OF CLASS DATA ========= -->
489<HR>
490
491
492<!-- ======= START OF BOTTOM NAVBAR ====== -->
493<A NAME="navbar_bottom"><!-- --></A>
494<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
495<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
496<TR>
497<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
498<A NAME="navbar_bottom_firstrow"><!-- --></A>
499<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
500  <TR ALIGN="center" VALIGN="top">
501  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
502  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
503  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
504  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SolrCache.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
505  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
506  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
507  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
508  </TR>
509</TABLE>
510</TD>
511<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
512</EM>
513</TD>
514</TR>
515
516<TR>
517<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
518&nbsp;<A HREF="../../../../org/apache/solr/search/ReturnFields.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A>&nbsp;
519&nbsp;<A HREF="../../../../org/apache/solr/search/SolrCache.State.html" title="enum in org.apache.solr.search"><B>NEXT CLASS</B></A></FONT></TD>
520<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
521  <A HREF="../../../../index.html?org/apache/solr/search/SolrCache.html" target="_top"><B>FRAMES</B></A>  &nbsp;
522&nbsp;<A HREF="SolrCache.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
523&nbsp;<SCRIPT type="text/javascript">
524  <!--
525  if(window==top) {
526    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
527  }
528  //-->
529</SCRIPT>
530<NOSCRIPT>
531  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
532</NOSCRIPT>
533
534
535</FONT></TD>
536</TR>
537<TR>
538<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
539  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
540<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
541DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
542</TR>
543</TABLE>
544<A NAME="skip-navbar_bottom"></A>
545<!-- ======== END OF BOTTOM NAVBAR ======= -->
546
547<HR>
548
549          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
550          <script src='../../../../prettify.js' type='text/javascript'></script>
551          <script type='text/javascript'>
552            (function(){
553              var oldonload = window.onload;
554              if (typeof oldonload != 'function') {
555                window.onload = prettyPrint;
556              } else {
557                window.onload = function() {
558                  oldonload();
559                  prettyPrint();
560                }
561              }
562            })();
563          </script>
564       
565</BODY>
566</HTML>
Note: See TracBrowser for help on using the repository browser.