solr-4.5.1/docs/solr-core/org/apache/solr/util/package-summary.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!-- NewPage -->
   3 <html lang="en">
   4 <head>
   5 <!-- Generated by javadoc (version 1.6.0_27) on Thu Oct 17 21:44:58 EDT 2013 -->
   6 <meta http-equiv="Content-Type" content="text/html" charset="utf-8">
   7 <title>org.apache.solr.util (Solr 4.5.1 API)</title>
   8 <meta name="date" content="2013-10-17">
   9 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  10 </head>
  11 <body>
  12 <script type="text/javascript"><!--
  13     if (location.href.indexOf('is-external=true') == -1) {
  14         parent.document.title="org.apache.solr.util (Solr 4.5.1 API)";
  15     }
  16 //-->
  17 </script>
  18 <noscript>
  19 <div>JavaScript is disabled on your browser.</div>
  20 </noscript>
  21 <!-- ========= START OF TOP NAVBAR ======= -->
  22 <div class="topNav"><a name="navbar_top">
  23 <!--   -->
  24 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
  25 <!--   -->
  26 </a>
  27 <ul class="navList" title="Navigation">
  28 <li><a href="../../../../overview-summary.html">Overview</a></li>
  29 <li class="navBarCell1Rev">Package</li>
  30 <li>Class</li>
  31 <li><a href="package-use.html">Use</a></li>
  32 <li><a href="package-tree.html">Tree</a></li>
  33 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  34 <li><a href="../../../../help-doc.html">Help</a></li>
  35 </ul>
  36 </div>
  37 <div class="subNav">
  38 <ul class="navList">
  39 <li><a href="../../../../org/apache/solr/update/processor/package-summary.html">PREV PACKAGE</a></li>
  40 <li><a href="../../../../org/apache/solr/util/plugin/package-summary.html">NEXT PACKAGE</a></li>
  41 </ul>
  42 <ul class="navList">
  43 <li><a href="../../../../index.html?org/apache/solr/util/package-summary.html" target="_top">FRAMES</a></li>
  44 <li><a href="package-summary.html" target="_top">NO FRAMES</a></li>
  45 </ul>
  46 <ul class="navList" id="allclasses_navbar_top">
  47 <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
  48 </ul>
  49 <div>
  50 <script type="text/javascript"><!--
  51   allClassesLink = document.getElementById("allclasses_navbar_top");
  52   if(window==top) {
  53     allClassesLink.style.display = "block";
  54   }
  55   else {
  56     allClassesLink.style.display = "none";
  57   }
  58   //-->
  59 </script>
  60 </div>
  61 <a name="skip-navbar_top">
  62 <!--   -->
  63 </a></div>
  64 <!-- ========= END OF TOP NAVBAR ========= -->
  65 <div class="header">
  66 <h1 title="Package" class="title">Package&nbsp;org.apache.solr.util</h1>
  67 <p class="subTitle">
  68 <div class="block">
  69 Common utility classes used throughout Solr</div>
  70 </p>
  71 <p>See:&nbsp;<a href="#package_description">Description</a></p>
  72 </div>
  73 <div class="contentContainer">
  74 <ul class="blockList">
  75 <li class="blockList">
  76 <table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
  77 <caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
  78 <tr>
  79 <th class="colFirst" scope="col">Interface</th>
  80 <th class="colLast" scope="col">Description</th>
  81 </tr>
  82 <tbody>
  83 <tr class="altColor">
  84 <td class="colFirst"><a href="../../../../org/apache/solr/util/ConcurrentLFUCache.EvictionListener.html" title="interface in org.apache.solr.util">ConcurrentLFUCache.EvictionListener&lt;K,V&gt;</a></td>
  85 <td class="colLast">&nbsp;</td>
  86 </tr>
  87 <tr class="rowColor">
  88 <td class="colFirst"><a href="../../../../org/apache/solr/util/ConcurrentLRUCache.EvictionListener.html" title="interface in org.apache.solr.util">ConcurrentLRUCache.EvictionListener&lt;K,V&gt;</a></td>
  89 <td class="colLast">&nbsp;</td>
  90 </tr>
  91 <tr class="altColor">
  92 <td class="colFirst"><a href="../../../../org/apache/solr/util/SolrLogLayout.TG.html" title="interface in org.apache.solr.util">SolrLogLayout.TG</a></td>
  93 <td class="colLast">
  94 <div class="block">Add this interface to a thread group and the string returned by getTag()
  95  will appear in log statements of any threads under that group.</div>
  96 </td>
  97 </tr>
  98 </tbody>
  99 </table>
 100 </li>
 101 <li class="blockList">
 102 <table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
 103 <caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
 104 <tr>
 105 <th class="colFirst" scope="col">Class</th>
 106 <th class="colLast" scope="col">Description</th>
 107 </tr>
 108 <tbody>
 109 <tr class="altColor">
 110 <td class="colFirst"><a href="../../../../org/apache/solr/util/AdjustableSemaphore.html" title="class in org.apache.solr.util">AdjustableSemaphore</a></td>
 111 <td class="colLast">&nbsp;</td>
 112 </tr>
 113 <tr class="rowColor">
 114 <td class="colFirst"><a href="../../../../org/apache/solr/util/BCDUtils.html" title="class in org.apache.solr.util">BCDUtils</a></td>
 115 <td class="colLast">&nbsp;</td>
 116 </tr>
 117 <tr class="altColor">
 118 <td class="colFirst"><a href="../../../../org/apache/solr/util/BoundedTreeSet.html" title="class in org.apache.solr.util">BoundedTreeSet&lt;E&gt;</a></td>
 119 <td class="colLast">
 120 <div class="block">A TreeSet that ensures it never grows beyond a max size.</div>
 121 </td>
 122 </tr>
 123 <tr class="rowColor">
 124 <td class="colFirst"><a href="../../../../org/apache/solr/util/ConcurrentLFUCache.html" title="class in org.apache.solr.util">ConcurrentLFUCache&lt;K,V&gt;</a></td>
 125 <td class="colLast">
 126 <div class="block">A LFU cache implementation based upon ConcurrentHashMap.</div>
 127 </td>
 128 </tr>
 129 <tr class="altColor">
 130 <td class="colFirst"><a href="../../../../org/apache/solr/util/ConcurrentLFUCache.Stats.html" title="class in org.apache.solr.util">ConcurrentLFUCache.Stats</a></td>
 131 <td class="colLast">&nbsp;</td>
 132 </tr>
 133 <tr class="rowColor">
 134 <td class="colFirst"><a href="../../../../org/apache/solr/util/ConcurrentLRUCache.html" title="class in org.apache.solr.util">ConcurrentLRUCache&lt;K,V&gt;</a></td>
 135 <td class="colLast">
 136 <div class="block">A LRU cache implementation based upon ConcurrentHashMap and other techniques to reduce
 137  contention and synchronization overhead to utilize multiple CPU cores more effectively.</div>
 138 </td>
 139 </tr>
 140 <tr class="altColor">
 141 <td class="colFirst"><a href="../../../../org/apache/solr/util/ConcurrentLRUCache.Stats.html" title="class in org.apache.solr.util">ConcurrentLRUCache.Stats</a></td>
 142 <td class="colLast">&nbsp;</td>
 143 </tr>
 144 <tr class="rowColor">
 145 <td class="colFirst"><a href="../../../../org/apache/solr/util/DateMathParser.html" title="class in org.apache.solr.util">DateMathParser</a></td>
 146 <td class="colLast">
 147 <div class="block">A Simple Utility class for parsing "math" like strings relating to Dates.</div>
 148 </td>
 149 </tr>
 150 <tr class="altColor">
 151 <td class="colFirst"><a href="../../../../org/apache/solr/util/DefaultSolrThreadFactory.html" title="class in org.apache.solr.util">DefaultSolrThreadFactory</a></td>
 152 <td class="colLast">&nbsp;</td>
 153 </tr>
 154 <tr class="rowColor">
 155 <td class="colFirst"><a href="../../../../org/apache/solr/util/DOMUtil.html" title="class in org.apache.solr.util">DOMUtil</a></td>
 156 <td class="colLast">&nbsp;</td>
 157 </tr>
 158 <tr class="altColor">
 159 <td class="colFirst"><a href="../../../../org/apache/solr/util/EmptyEntityResolver.html" title="class in org.apache.solr.util">EmptyEntityResolver</a></td>
 160 <td class="colLast">
 161 <div class="block">This class provides several singletons of entity resolvers used by
 162  SAX and StAX in the Java API.</div>
 163 </td>
 164 </tr>
 165 <tr class="rowColor">
 166 <td class="colFirst"><a href="../../../../org/apache/solr/util/FastWriter.html" title="class in org.apache.solr.util">FastWriter</a></td>
 167 <td class="colLast">
 168 <div class="block">Single threaded BufferedWriter
 169   Internal Solr use only, subject to change.</div>
 170 </td>
 171 </tr>
 172 <tr class="altColor">
 173 <td class="colFirst"><a href="../../../../org/apache/solr/util/FileUtils.html" title="class in org.apache.solr.util">FileUtils</a></td>
 174 <td class="colLast">&nbsp;</td>
 175 </tr>
 176 <tr class="rowColor">
 177 <td class="colFirst"><a href="../../../../org/apache/solr/util/HdfsUtil.html" title="class in org.apache.solr.util">HdfsUtil</a></td>
 178 <td class="colLast">&nbsp;</td>
 179 </tr>
 180 <tr class="altColor">
 181 <td class="colFirst"><a href="../../../../org/apache/solr/util/IOUtils.html" title="class in org.apache.solr.util">IOUtils</a></td>
 182 <td class="colLast">&nbsp;</td>
 183 </tr>
 184 <tr class="rowColor">
 185 <td class="colFirst"><a href="../../../../org/apache/solr/util/LongPriorityQueue.html" title="class in org.apache.solr.util">LongPriorityQueue</a></td>
 186 <td class="colLast">
 187 <div class="block">A native long priority queue.</div>
 188 </td>
 189 </tr>
 190 <tr class="altColor">
 191 <td class="colFirst"><a href="../../../../org/apache/solr/util/MapListener.html" title="class in org.apache.solr.util">MapListener&lt;K,V&gt;</a></td>
 192 <td class="colLast">
 193 <div class="block">Wraps another map, keeping track of each key that was seen via <a href="../../../../org/apache/solr/util/MapListener.html#get(java.lang.Object)"><code>MapListener.get(Object)</code></a> or <a href="../../../../org/apache/solr/util/MapListener.html#remove(java.lang.Object)"><code>MapListener.remove(Object)</code></a>.</div>
 194 </td>
 195 </tr>
 196 <tr class="rowColor">
 197 <td class="colFirst"><a href="../../../../org/apache/solr/util/NumberUtils.html" title="class in org.apache.solr.util">NumberUtils</a></td>
 198 <td class="colLast">&nbsp;</td>
 199 </tr>
 200 <tr class="altColor">
 201 <td class="colFirst"><a href="../../../../org/apache/solr/util/PrimUtils.html" title="class in org.apache.solr.util">PrimUtils</a></td>
 202 <td class="colLast">
 203 <div class="block">Utilities for primitive Java data types.</div>
 204 </td>
 205 </tr>
 206 <tr class="rowColor">
 207 <td class="colFirst"><a href="../../../../org/apache/solr/util/PrimUtils.IntComparator.html" title="class in org.apache.solr.util">PrimUtils.IntComparator</a></td>
 208 <td class="colLast">&nbsp;</td>
 209 </tr>
 210 <tr class="altColor">
 211 <td class="colFirst"><a href="../../../../org/apache/solr/util/PropertiesInputStream.html" title="class in org.apache.solr.util">PropertiesInputStream</a></td>
 212 <td class="colLast">&nbsp;</td>
 213 </tr>
 214 <tr class="rowColor">
 215 <td class="colFirst"><a href="../../../../org/apache/solr/util/PropertiesOutputStream.html" title="class in org.apache.solr.util">PropertiesOutputStream</a></td>
 216 <td class="colLast">&nbsp;</td>
 217 </tr>
 218 <tr class="altColor">
 219 <td class="colFirst"><a href="../../../../org/apache/solr/util/PropertiesUtil.html" title="class in org.apache.solr.util">PropertiesUtil</a></td>
 220 <td class="colLast">
 221 <div class="block">Breaking out some utility methods into a separate class as part of SOLR-4196.</div>
 222 </td>
 223 </tr>
 224 <tr class="rowColor">
 225 <td class="colFirst"><a href="../../../../org/apache/solr/util/RefCounted.html" title="class in org.apache.solr.util">RefCounted&lt;Type&gt;</a></td>
 226 <td class="colLast">
 227 <div class="block">Keep track of a reference count on a resource and close it when
 228  the count hits zero.</div>
 229 </td>
 230 </tr>
 231 <tr class="altColor">
 232 <td class="colFirst"><a href="../../../../org/apache/solr/util/RegexFileFilter.html" title="class in org.apache.solr.util">RegexFileFilter</a></td>
 233 <td class="colLast">
 234 <div class="block">Accepts any file whose name matches the pattern</div>
 235 </td>
 236 </tr>
 237 <tr class="rowColor">
 238 <td class="colFirst"><a href="../../../../org/apache/solr/util/RTimer.html" title="class in org.apache.solr.util">RTimer</a></td>
 239 <td class="colLast">
 240 <div class="block">A recursive timer.</div>
 241 </td>
 242 </tr>
 243 <tr class="altColor">
 244 <td class="colFirst"><a href="../../../../org/apache/solr/util/SimplePostTool.html" title="class in org.apache.solr.util">SimplePostTool</a></td>
 245 <td class="colLast">
 246 <div class="block">A simple utility class for posting raw updates to a Solr server,
 247  has a main method so it can be run on the command line.</div>
 248 </td>
 249 </tr>
 250 <tr class="altColor">
 251 <td class="colFirst"><a href="../../../../org/apache/solr/util/SolrLogLayout.html" title="class in org.apache.solr.util">SolrLogLayout</a></td>
 252 <td class="colLast">&nbsp;</td>
 253 </tr>
 254 <tr class="rowColor">
 255 <td class="colFirst"><a href="../../../../org/apache/solr/util/SolrLogLayout.CoreInfo.html" title="class in org.apache.solr.util">SolrLogLayout.CoreInfo</a></td>
 256 <td class="colLast">&nbsp;</td>
 257 </tr>
 258 <tr class="altColor">
 259 <td class="colFirst"><a href="../../../../org/apache/solr/util/SolrLogLayout.Method.html" title="class in org.apache.solr.util">SolrLogLayout.Method</a></td>
 260 <td class="colLast">&nbsp;</td>
 261 </tr>
 262 <tr class="rowColor">
 263 <td class="colFirst"><a href="../../../../org/apache/solr/util/SolrPluginUtils.html" title="class in org.apache.solr.util">SolrPluginUtils</a></td>
 264 <td class="colLast">
 265 <div class="block">Utilities that may be of use to RequestHandlers.</div>
 266 </td>
 267 </tr>
 268 <tr class="altColor">
 269 <td class="colFirst"><a href="../../../../org/apache/solr/util/SolrPluginUtils.DisjunctionMaxQueryParser.html" title="class in org.apache.solr.util">SolrPluginUtils.DisjunctionMaxQueryParser</a></td>
 270 <td class="colLast">
 271 <div class="block">A subclass of SolrQueryParser that supports aliasing fields for
 272  constructing DisjunctionMaxQueries.</div>
 273 </td>
 274 </tr>
 275 <tr class="rowColor">
 276 <td class="colFirst"><a href="../../../../org/apache/solr/util/SolrPluginUtils.DisjunctionMaxQueryParser.Alias.html" title="class in org.apache.solr.util">SolrPluginUtils.DisjunctionMaxQueryParser.Alias</a></td>
 277 <td class="colLast">
 278 <div class="block">A simple container for storing alias info</div>
 279 </td>
 280 </tr>
 281 <tr class="altColor">
 282 <td class="colFirst"><a href="../../../../org/apache/solr/util/SolrPluginUtils.IdentityRegenerator.html" title="class in org.apache.solr.util">SolrPluginUtils.IdentityRegenerator</a></td>
 283 <td class="colLast">
 284 <div class="block">A CacheRegenerator that can be used whenever the items in the cache
 285  are not dependant on the current searcher.</div>
 286 </td>
 287 </tr>
 288 <tr class="rowColor">
 289 <td class="colFirst"><a href="../../../../org/apache/solr/util/SystemIdResolver.html" title="class in org.apache.solr.util">SystemIdResolver</a></td>
 290 <td class="colLast">
 291 <div class="block">This is a helper class to support resolving of XIncludes or other hrefs
 292  inside XML files on top of a <a href="http://lucene.apache.org/core/4_5_1/analyzers-common/org/apache/lucene/analysis/util/ResourceLoader.html?is-external=true" title="class or interface in org.apache.lucene.analysis.util"><code>ResourceLoader</code></a>.</div>
 293 </td>
 294 </tr>
 295 <tr class="altColor">
 296 <td class="colFirst"><a href="../../../../org/apache/solr/util/TimeZoneUtils.html" title="class in org.apache.solr.util">TimeZoneUtils</a></td>
 297 <td class="colLast">
 298 <div class="block">Simple utilities for working with TimeZones</div>
 299 </td>
 300 </tr>
 301 <tr class="rowColor">
 302 <td class="colFirst"><a href="../../../../org/apache/solr/util/VersionedFile.html" title="class in org.apache.solr.util">VersionedFile</a></td>
 303 <td class="colLast">&nbsp;</td>
 304 </tr>
 305 </tbody>
 306 </table>
 307 </li>
 308 </ul>
 309 <a name="package_description">
 310 <!--   -->
 311 </a>
 312 <h2 title="Package org.apache.solr.util Description">Package org.apache.solr.util Description</h2>
 313 <div class="block"><p>
 314 Common utility classes used throughout Solr
 315
 316
 317 </p></div>
 318 </div>
 319 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 320 <div class="bottomNav"><a name="navbar_bottom">
 321 <!--   -->
 322 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
 323 <!--   -->
 324 </a>
 325 <ul class="navList" title="Navigation">
 326 <li><a href="../../../../overview-summary.html">Overview</a></li>
 327 <li class="navBarCell1Rev">Package</li>
 328 <li>Class</li>
 329 <li><a href="package-use.html">Use</a></li>
 330 <li><a href="package-tree.html">Tree</a></li>
 331 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 332 <li><a href="../../../../help-doc.html">Help</a></li>
 333 </ul>
 334 </div>
 335 <div class="subNav">
 336 <ul class="navList">
 337 <li><a href="../../../../org/apache/solr/update/processor/package-summary.html">PREV PACKAGE</a></li>
 338 <li><a href="../../../../org/apache/solr/util/plugin/package-summary.html">NEXT PACKAGE</a></li>
 339 </ul>
 340 <ul class="navList">
 341 <li><a href="../../../../index.html?org/apache/solr/util/package-summary.html" target="_top">FRAMES</a></li>
 342 <li><a href="package-summary.html" target="_top">NO FRAMES</a></li>
 343 </ul>
 344 <ul class="navList" id="allclasses_navbar_bottom">
 345 <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
 346 </ul>
 347 <div>
 348 <script type="text/javascript"><!--
 349   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 350   if(window==top) {
 351     allClassesLink.style.display = "block";
 352   }
 353   else {
 354     allClassesLink.style.display = "none";
 355   }
 356   //-->
 357 </script>
 358 </div>
 359 <a name="skip-navbar_bottom">
 360 <!--   -->
 361 </a></div>
 362 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 363 <p class="legalCopy"><small>
 364           <i>Copyright &copy; 2000-2013 Apache Software Foundation.  All Rights Reserved.</i>
 365           <script src='../../../../prettify.js' type='text/javascript'></script>
 366           <script type='text/javascript'>
 367             (function(){
 368               var oldonload = window.onload;
 369               if (typeof oldonload != 'function') {
 370                 window.onload = prettyPrint;
 371               } else {
 372                 window.onload = function() {
 373                   oldonload();
 374                   prettyPrint();
 375                 }
 376               }
 377             })();
 378           </script>
 379         </small></p>
 380 </body>
 381 </html>