[7588] | 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> |
---|
| 8 | DIHCache (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"> |
---|
| 16 | function windowTitle() |
---|
| 17 | { |
---|
| 18 | if (location.href.indexOf('is-external=true') == -1) { |
---|
| 19 | parent.document.title="DIHCache (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> </TD> |
---|
| 42 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
| 43 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
| 44 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DIHCache.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
| 45 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
| 46 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
| 47 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 | <A HREF="../../../../../org/apache/solr/handler/dataimport/DebugInfo.html" title="class in org.apache.solr.handler.dataimport"><B>PREV CLASS</B></A> |
---|
| 59 | <A HREF="../../../../../org/apache/solr/handler/dataimport/DIHCacheSupport.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/DIHCache.html" target="_top"><B>FRAMES</B></A> |
---|
| 62 | <A HREF="DIHCache.html" target="_top"><B>NO FRAMES</B></A> |
---|
| 63 | <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
| 80 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 81 | DETAIL: FIELD | CONSTR | <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"> |
---|
| 91 | org.apache.solr.handler.dataimport</FONT> |
---|
| 92 | <BR> |
---|
| 93 | Interface DIHCache</H2> |
---|
| 94 | <DL> |
---|
| 95 | <DT><B>All Superinterfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><<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><<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>>></DD> |
---|
| 96 | </DL> |
---|
| 97 | <DL> |
---|
| 98 | <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/solr/handler/dataimport/SortedMapBackedCache.html" title="class in org.apache.solr.handler.dataimport">SortedMapBackedCache</A></DD> |
---|
| 99 | </DL> |
---|
| 100 | <HR> |
---|
| 101 | <DL> |
---|
| 102 | <DT><PRE>public interface <B>DIHCache</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><<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><<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>>></DL> |
---|
| 103 | </PRE> |
---|
| 104 | |
---|
| 105 | <P> |
---|
| 106 | <p> |
---|
| 107 | A cache that allows a DIH entity's data to persist locally prior being joined |
---|
| 108 | to other data and/or indexed. |
---|
| 109 | </p> |
---|
| 110 | <P> |
---|
| 111 | |
---|
| 112 | <P> |
---|
| 113 | <DL> |
---|
| 114 | <DT><B>WARNING: This API is experimental and might change in incompatible ways in the next release.</B></DT> |
---|
| 115 | <DD></DD> |
---|
| 116 | </DL> |
---|
| 117 | <HR> |
---|
| 118 | |
---|
| 119 | <P> |
---|
| 120 | |
---|
| 121 | <!-- ========== METHOD SUMMARY =========== --> |
---|
| 122 | |
---|
| 123 | <A NAME="method_summary"><!-- --></A> |
---|
| 124 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 125 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 126 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
| 127 | <B>Method Summary</B></FONT></TH> |
---|
| 128 | </TR> |
---|
| 129 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 130 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 131 | <CODE> void</CODE></FONT></TD> |
---|
| 132 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/DIHCache.html#add(java.util.Map)">add</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><<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>> rec)</CODE> |
---|
| 133 | |
---|
| 134 | <BR> |
---|
| 135 | |
---|
| 136 | Adds a document.</TD> |
---|
| 137 | </TR> |
---|
| 138 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 139 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 140 | <CODE> void</CODE></FONT></TD> |
---|
| 141 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/DIHCache.html#close()">close</A></B>()</CODE> |
---|
| 142 | |
---|
| 143 | <BR> |
---|
| 144 | |
---|
| 145 | Releases resources used by this cache, if possible.</TD> |
---|
| 146 | </TR> |
---|
| 147 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 148 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 149 | <CODE> void</CODE></FONT></TD> |
---|
| 150 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/DIHCache.html#delete(java.lang.Object)">delete</A></B>(<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> key)</CODE> |
---|
| 151 | |
---|
| 152 | <BR> |
---|
| 153 | |
---|
| 154 | Delete all documents associated with the given key</TD> |
---|
| 155 | </TR> |
---|
| 156 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 157 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 158 | <CODE> void</CODE></FONT></TD> |
---|
| 159 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/DIHCache.html#deleteAll()">deleteAll</A></B>()</CODE> |
---|
| 160 | |
---|
| 161 | <BR> |
---|
| 162 | |
---|
| 163 | Delete all data from the cache,leaving the empty cache intact.</TD> |
---|
| 164 | </TR> |
---|
| 165 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 166 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 167 | <CODE> void</CODE></FONT></TD> |
---|
| 168 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/DIHCache.html#destroy()">destroy</A></B>()</CODE> |
---|
| 169 | |
---|
| 170 | <BR> |
---|
| 171 | |
---|
| 172 | Closes the cache, if open.</TD> |
---|
| 173 | </TR> |
---|
| 174 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 175 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 176 | <CODE> void</CODE></FONT></TD> |
---|
| 177 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/DIHCache.html#flush()">flush</A></B>()</CODE> |
---|
| 178 | |
---|
| 179 | <BR> |
---|
| 180 | |
---|
| 181 | Persists any pending data to the cache</TD> |
---|
| 182 | </TR> |
---|
| 183 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 184 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 185 | <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<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><<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>>></CODE></FONT></TD> |
---|
| 186 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/DIHCache.html#iterator()">iterator</A></B>()</CODE> |
---|
| 187 | |
---|
| 188 | <BR> |
---|
| 189 | |
---|
| 190 | Returns an iterator, allowing callers to iterate through the entire cache |
---|
| 191 | in key, then insertion, order.</TD> |
---|
| 192 | </TR> |
---|
| 193 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 194 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 195 | <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<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><<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>>></CODE></FONT></TD> |
---|
| 196 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/DIHCache.html#iterator(java.lang.Object)">iterator</A></B>(<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> key)</CODE> |
---|
| 197 | |
---|
| 198 | <BR> |
---|
| 199 | |
---|
| 200 | Returns an iterator, allowing callers to iterate through all documents that |
---|
| 201 | match the given key in insertion order.</TD> |
---|
| 202 | </TR> |
---|
| 203 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 204 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 205 | <CODE> void</CODE></FONT></TD> |
---|
| 206 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/DIHCache.html#open(org.apache.solr.handler.dataimport.Context)">open</A></B>(<A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html" title="class in org.apache.solr.handler.dataimport">Context</A> context)</CODE> |
---|
| 207 | |
---|
| 208 | <BR> |
---|
| 209 | |
---|
| 210 | Opens the cache using the specified properties.</TD> |
---|
| 211 | </TR> |
---|
| 212 | </TABLE> |
---|
| 213 | |
---|
| 214 | <P> |
---|
| 215 | |
---|
| 216 | <!-- ============ METHOD DETAIL ========== --> |
---|
| 217 | |
---|
| 218 | <A NAME="method_detail"><!-- --></A> |
---|
| 219 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 220 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 221 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
| 222 | <B>Method Detail</B></FONT></TH> |
---|
| 223 | </TR> |
---|
| 224 | </TABLE> |
---|
| 225 | |
---|
| 226 | <A NAME="open(org.apache.solr.handler.dataimport.Context)"><!-- --></A><H3> |
---|
| 227 | open</H3> |
---|
| 228 | <PRE> |
---|
| 229 | void <B>open</B>(<A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html" title="class in org.apache.solr.handler.dataimport">Context</A> context)</PRE> |
---|
| 230 | <DL> |
---|
| 231 | <DD><p> |
---|
| 232 | Opens the cache using the specified properties. The <A HREF="../../../../../org/apache/solr/handler/dataimport/Context.html" title="class in org.apache.solr.handler.dataimport"><CODE>Context</CODE></A> |
---|
| 233 | includes any parameters needed by the cache impl. This must be called |
---|
| 234 | before any read/write operations are permitted. |
---|
| 235 | <p> |
---|
| 236 | <P> |
---|
| 237 | <DD><DL> |
---|
| 238 | </DL> |
---|
| 239 | </DD> |
---|
| 240 | <DD><DL> |
---|
| 241 | </DL> |
---|
| 242 | </DD> |
---|
| 243 | </DL> |
---|
| 244 | <HR> |
---|
| 245 | |
---|
| 246 | <A NAME="close()"><!-- --></A><H3> |
---|
| 247 | close</H3> |
---|
| 248 | <PRE> |
---|
| 249 | void <B>close</B>()</PRE> |
---|
| 250 | <DL> |
---|
| 251 | <DD><p> |
---|
| 252 | Releases resources used by this cache, if possible. The cache is flushed |
---|
| 253 | but not destroyed. |
---|
| 254 | </p> |
---|
| 255 | <P> |
---|
| 256 | <DD><DL> |
---|
| 257 | </DL> |
---|
| 258 | </DD> |
---|
| 259 | <DD><DL> |
---|
| 260 | </DL> |
---|
| 261 | </DD> |
---|
| 262 | </DL> |
---|
| 263 | <HR> |
---|
| 264 | |
---|
| 265 | <A NAME="flush()"><!-- --></A><H3> |
---|
| 266 | flush</H3> |
---|
| 267 | <PRE> |
---|
| 268 | void <B>flush</B>()</PRE> |
---|
| 269 | <DL> |
---|
| 270 | <DD><p> |
---|
| 271 | Persists any pending data to the cache |
---|
| 272 | </p> |
---|
| 273 | <P> |
---|
| 274 | <DD><DL> |
---|
| 275 | </DL> |
---|
| 276 | </DD> |
---|
| 277 | <DD><DL> |
---|
| 278 | </DL> |
---|
| 279 | </DD> |
---|
| 280 | </DL> |
---|
| 281 | <HR> |
---|
| 282 | |
---|
| 283 | <A NAME="destroy()"><!-- --></A><H3> |
---|
| 284 | destroy</H3> |
---|
| 285 | <PRE> |
---|
| 286 | void <B>destroy</B>()</PRE> |
---|
| 287 | <DL> |
---|
| 288 | <DD><p> |
---|
| 289 | Closes the cache, if open. Then removes all data, possibly removing the |
---|
| 290 | cache entirely from persistent storage. |
---|
| 291 | </p> |
---|
| 292 | <P> |
---|
| 293 | <DD><DL> |
---|
| 294 | </DL> |
---|
| 295 | </DD> |
---|
| 296 | <DD><DL> |
---|
| 297 | </DL> |
---|
| 298 | </DD> |
---|
| 299 | </DL> |
---|
| 300 | <HR> |
---|
| 301 | |
---|
| 302 | <A NAME="add(java.util.Map)"><!-- --></A><H3> |
---|
| 303 | add</H3> |
---|
| 304 | <PRE> |
---|
| 305 | void <B>add</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><<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>> rec)</PRE> |
---|
| 306 | <DL> |
---|
| 307 | <DD><p> |
---|
| 308 | Adds a document. If a document already exists with the same key, both |
---|
| 309 | documents will exist in the cache, as the cache allows duplicate keys. To |
---|
| 310 | update a key's documents, first call delete(Object key). |
---|
| 311 | </p> |
---|
| 312 | <P> |
---|
| 313 | <DD><DL> |
---|
| 314 | </DL> |
---|
| 315 | </DD> |
---|
| 316 | <DD><DL> |
---|
| 317 | <DT><B>Parameters:</B><DD><CODE>rec</CODE> - </DL> |
---|
| 318 | </DD> |
---|
| 319 | </DL> |
---|
| 320 | <HR> |
---|
| 321 | |
---|
| 322 | <A NAME="iterator()"><!-- --></A><H3> |
---|
| 323 | iterator</H3> |
---|
| 324 | <PRE> |
---|
| 325 | <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<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><<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>>> <B>iterator</B>()</PRE> |
---|
| 326 | <DL> |
---|
| 327 | <DD><p> |
---|
| 328 | Returns an iterator, allowing callers to iterate through the entire cache |
---|
| 329 | in key, then insertion, order. |
---|
| 330 | </p> |
---|
| 331 | <P> |
---|
| 332 | <DD><DL> |
---|
| 333 | <DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang">iterator</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><<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><<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>>></CODE></DL> |
---|
| 334 | </DD> |
---|
| 335 | <DD><DL> |
---|
| 336 | </DL> |
---|
| 337 | </DD> |
---|
| 338 | </DL> |
---|
| 339 | <HR> |
---|
| 340 | |
---|
| 341 | <A NAME="iterator(java.lang.Object)"><!-- --></A><H3> |
---|
| 342 | iterator</H3> |
---|
| 343 | <PRE> |
---|
| 344 | <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<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><<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>>> <B>iterator</B>(<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> key)</PRE> |
---|
| 345 | <DL> |
---|
| 346 | <DD><p> |
---|
| 347 | Returns an iterator, allowing callers to iterate through all documents that |
---|
| 348 | match the given key in insertion order. |
---|
| 349 | </p> |
---|
| 350 | <P> |
---|
| 351 | <DD><DL> |
---|
| 352 | </DL> |
---|
| 353 | </DD> |
---|
| 354 | <DD><DL> |
---|
| 355 | </DL> |
---|
| 356 | </DD> |
---|
| 357 | </DL> |
---|
| 358 | <HR> |
---|
| 359 | |
---|
| 360 | <A NAME="delete(java.lang.Object)"><!-- --></A><H3> |
---|
| 361 | delete</H3> |
---|
| 362 | <PRE> |
---|
| 363 | void <B>delete</B>(<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> key)</PRE> |
---|
| 364 | <DL> |
---|
| 365 | <DD><p> |
---|
| 366 | Delete all documents associated with the given key |
---|
| 367 | </p> |
---|
| 368 | <P> |
---|
| 369 | <DD><DL> |
---|
| 370 | </DL> |
---|
| 371 | </DD> |
---|
| 372 | <DD><DL> |
---|
| 373 | <DT><B>Parameters:</B><DD><CODE>key</CODE> - </DL> |
---|
| 374 | </DD> |
---|
| 375 | </DL> |
---|
| 376 | <HR> |
---|
| 377 | |
---|
| 378 | <A NAME="deleteAll()"><!-- --></A><H3> |
---|
| 379 | deleteAll</H3> |
---|
| 380 | <PRE> |
---|
| 381 | void <B>deleteAll</B>()</PRE> |
---|
| 382 | <DL> |
---|
| 383 | <DD><p> |
---|
| 384 | Delete all data from the cache,leaving the empty cache intact. |
---|
| 385 | </p> |
---|
| 386 | <P> |
---|
| 387 | <DD><DL> |
---|
| 388 | </DL> |
---|
| 389 | </DD> |
---|
| 390 | <DD><DL> |
---|
| 391 | </DL> |
---|
| 392 | </DD> |
---|
| 393 | </DL> |
---|
| 394 | <!-- ========= END OF CLASS DATA ========= --> |
---|
| 395 | <HR> |
---|
| 396 | |
---|
| 397 | |
---|
| 398 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
| 399 | <A NAME="navbar_bottom"><!-- --></A> |
---|
| 400 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
| 401 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
| 402 | <TR> |
---|
| 403 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
| 404 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
| 405 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
| 406 | <TR ALIGN="center" VALIGN="top"> |
---|
| 407 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
| 408 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
| 409 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
| 410 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DIHCache.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
| 411 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
| 412 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
| 413 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
| 414 | </TR> |
---|
| 415 | </TABLE> |
---|
| 416 | </TD> |
---|
| 417 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
| 418 | </EM> |
---|
| 419 | </TD> |
---|
| 420 | </TR> |
---|
| 421 | |
---|
| 422 | <TR> |
---|
| 423 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 424 | <A HREF="../../../../../org/apache/solr/handler/dataimport/DebugInfo.html" title="class in org.apache.solr.handler.dataimport"><B>PREV CLASS</B></A> |
---|
| 425 | <A HREF="../../../../../org/apache/solr/handler/dataimport/DIHCacheSupport.html" title="class in org.apache.solr.handler.dataimport"><B>NEXT CLASS</B></A></FONT></TD> |
---|
| 426 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 427 | <A HREF="../../../../../index.html?org/apache/solr/handler/dataimport/DIHCache.html" target="_top"><B>FRAMES</B></A> |
---|
| 428 | <A HREF="DIHCache.html" target="_top"><B>NO FRAMES</B></A> |
---|
| 429 | <SCRIPT type="text/javascript"> |
---|
| 430 | <!-- |
---|
| 431 | if(window==top) { |
---|
| 432 | document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
| 433 | } |
---|
| 434 | //--> |
---|
| 435 | </SCRIPT> |
---|
| 436 | <NOSCRIPT> |
---|
| 437 | <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
| 438 | </NOSCRIPT> |
---|
| 439 | |
---|
| 440 | |
---|
| 441 | </FONT></TD> |
---|
| 442 | </TR> |
---|
| 443 | <TR> |
---|
| 444 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 445 | SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
| 446 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 447 | DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
| 448 | </TR> |
---|
| 449 | </TABLE> |
---|
| 450 | <A NAME="skip-navbar_bottom"></A> |
---|
| 451 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
| 452 | |
---|
| 453 | <HR> |
---|
| 454 | |
---|
| 455 | <address>Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.</address> |
---|
| 456 | <script src='../../../../../prettify.js' type='text/javascript'></script> |
---|
| 457 | <script type='text/javascript'> |
---|
| 458 | (function(){ |
---|
| 459 | var oldonload = window.onload; |
---|
| 460 | if (typeof oldonload != 'function') { |
---|
| 461 | window.onload = prettyPrint; |
---|
| 462 | } else { |
---|
| 463 | window.onload = function() { |
---|
| 464 | oldonload(); |
---|
| 465 | prettyPrint(); |
---|
| 466 | } |
---|
| 467 | } |
---|
| 468 | })(); |
---|
| 469 | </script> |
---|
| 470 | |
---|
| 471 | </BODY> |
---|
| 472 | </HTML> |
---|