solr-4.6.0/docs/solr-core/org/apache/solr/core/StandardDirectoryFactory.html

   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_30) on Tue Nov 19 11:16:52 CET 2013 -->
   6 <META http-equiv="Content-Type" content="text/html; charset=utf-8">
   7 <TITLE>
   8 StandardDirectoryFactory (Solr 4.6.0 API)
   9 </TITLE>
  10
  11 <META NAME="date" CONTENT="2013-11-19">
  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="StandardDirectoryFactory (Solr 4.6.0 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/StandardDirectoryFactory.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/SolrXMLSerializer.SolrXMLDef.html" title="class in org.apache.solr.core"><B>PREV CLASS</B></A>&nbsp;
  59 &nbsp;<A HREF="../../../../org/apache/solr/core/StandardIndexReaderFactory.html" title="class 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/StandardDirectoryFactory.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  62 &nbsp;<A HREF="StandardDirectoryFactory.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_classes_inherited_from_class_org.apache.solr.core.CachingDirectoryFactory">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.solr.core.CachingDirectoryFactory">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&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">
  91 org.apache.solr.core</FONT>
  92 <BR>
  93 Class StandardDirectoryFactory</H2>
  94 <PRE>
  95 <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
  96   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/solr/core/DirectoryFactory.html" title="class in org.apache.solr.core">org.apache.solr.core.DirectoryFactory</A>
  97       <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html" title="class in org.apache.solr.core">org.apache.solr.core.CachingDirectoryFactory</A>
  98           <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.core.StandardDirectoryFactory</B>
  99 </PRE>
 100 <DL>
 101 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</A>, <A HREF="../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html" title="interface in org.apache.solr.util.plugin">NamedListInitializedPlugin</A></DD>
 102 </DL>
 103 <DL>
 104 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/solr/core/MMapDirectoryFactory.html" title="class in org.apache.solr.core">MMapDirectoryFactory</A>, <A HREF="../../../../org/apache/solr/core/NIOFSDirectoryFactory.html" title="class in org.apache.solr.core">NIOFSDirectoryFactory</A>, <A HREF="../../../../org/apache/solr/core/NRTCachingDirectoryFactory.html" title="class in org.apache.solr.core">NRTCachingDirectoryFactory</A>, <A HREF="../../../../org/apache/solr/core/SimpleFSDirectoryFactory.html" title="class in org.apache.solr.core">SimpleFSDirectoryFactory</A></DD>
 105 </DL>
 106 <HR>
 107 <DL>
 108 <DT><PRE>public class <B>StandardDirectoryFactory</B><DT>extends <A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html" title="class in org.apache.solr.core">CachingDirectoryFactory</A></DL>
 109 </PRE>
 110
 111 <P>
 112 Directory provider which mimics original Solr
 113  <A HREF="http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/store/FSDirectory.html?is-external=true" title="class or interface in org.apache.lucene.store"><CODE>FSDirectory</CODE></A> based behavior.
 114
 115  File based DirectoryFactory implementations generally extend
 116  this class.
 117 <P>
 118
 119 <P>
 120 <HR>
 121
 122 <P>
 123 <!-- ======== NESTED CLASS SUMMARY ======== -->
 124
 125 <A NAME="nested_class_summary"><!-- --></A>
 126 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 127 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 128 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 129 <B>Nested Class Summary</B></FONT></TH>
 130 </TR>
 131 </TABLE>
 132 &nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.solr.core.CachingDirectoryFactory"><!-- --></A>
 133 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 134 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 135 <TH ALIGN="left"><B>Nested classes/interfaces inherited from class org.apache.solr.core.<A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html" title="class in org.apache.solr.core">CachingDirectoryFactory</A></B></TH>
 136 </TR>
 137 <TR BGCOLOR="white" CLASS="TableRowColor">
 138 <TD><CODE><A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.CacheValue.html" title="class in org.apache.solr.core">CachingDirectoryFactory.CacheValue</A>, <A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.CloseListener.html" title="interface in org.apache.solr.core">CachingDirectoryFactory.CloseListener</A></CODE></TD>
 139 </TR>
 140 </TABLE>
 141 &nbsp;
 142 <A NAME="nested_classes_inherited_from_class_org.apache.solr.core.DirectoryFactory"><!-- --></A>
 143 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 144 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 145 <TH ALIGN="left"><B>Nested classes/interfaces inherited from class org.apache.solr.core.<A HREF="../../../../org/apache/solr/core/DirectoryFactory.html" title="class in org.apache.solr.core">DirectoryFactory</A></B></TH>
 146 </TR>
 147 <TR BGCOLOR="white" CLASS="TableRowColor">
 148 <TD><CODE><A HREF="../../../../org/apache/solr/core/DirectoryFactory.DirContext.html" title="enum in org.apache.solr.core">DirectoryFactory.DirContext</A></CODE></TD>
 149 </TR>
 150 </TABLE>
 151 &nbsp;
 152 <!-- =========== FIELD SUMMARY =========== -->
 153
 154 <A NAME="field_summary"><!-- --></A>
 155 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 156 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 157 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 158 <B>Field Summary</B></FONT></TH>
 159 </TR>
 160 </TABLE>
 161 &nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.core.CachingDirectoryFactory"><!-- --></A>
 162 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 163 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 164 <TH ALIGN="left"><B>Fields inherited from class org.apache.solr.core.<A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html" title="class in org.apache.solr.core">CachingDirectoryFactory</A></B></TH>
 165 </TR>
 166 <TR BGCOLOR="white" CLASS="TableRowColor">
 167 <TD><CODE><A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#byDirectoryCache">byDirectoryCache</A>, <A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#byPathCache">byPathCache</A>, <A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#closeListeners">closeListeners</A>, <A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#removeEntries">removeEntries</A></CODE></TD>
 168 </TR>
 169 </TABLE>
 170 &nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.core.DirectoryFactory"><!-- --></A>
 171 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 172 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 173 <TH ALIGN="left"><B>Fields inherited from class org.apache.solr.core.<A HREF="../../../../org/apache/solr/core/DirectoryFactory.html" title="class in org.apache.solr.core">DirectoryFactory</A></B></TH>
 174 </TR>
 175 <TR BGCOLOR="white" CLASS="TableRowColor">
 176 <TD><CODE><A HREF="../../../../org/apache/solr/core/DirectoryFactory.html#IOCONTEXT_NO_CACHE">IOCONTEXT_NO_CACHE</A></CODE></TD>
 177 </TR>
 178 </TABLE>
 179 &nbsp;
 180 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 181
 182 <A NAME="constructor_summary"><!-- --></A>
 183 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 184 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 185 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 186 <B>Constructor Summary</B></FONT></TH>
 187 </TR>
 188 <TR BGCOLOR="white" CLASS="TableRowColor">
 189 <TD><CODE><B><A HREF="../../../../org/apache/solr/core/StandardDirectoryFactory.html#StandardDirectoryFactory()">StandardDirectoryFactory</A></B>()</CODE>
 190
 191 <BR>
 192 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 193 </TR>
 194 </TABLE>
 195 &nbsp;
 196 <!-- ========== METHOD SUMMARY =========== -->
 197
 198 <A NAME="method_summary"><!-- --></A>
 199 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 200 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 201 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 202 <B>Method Summary</B></FONT></TH>
 203 </TR>
 204 <TR BGCOLOR="white" CLASS="TableRowColor">
 205 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 206 <CODE>protected &nbsp;<A HREF="http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/store/Directory.html?is-external=true" title="class or interface in org.apache.lucene.store">Directory</A></CODE></FONT></TD>
 207 <TD><CODE><B><A HREF="../../../../org/apache/solr/core/StandardDirectoryFactory.html#create(java.lang.String, org.apache.solr.core.DirectoryFactory.DirContext)">create</A></B>(<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>&nbsp;path,
 208        <A HREF="../../../../org/apache/solr/core/DirectoryFactory.DirContext.html" title="enum in org.apache.solr.core">DirectoryFactory.DirContext</A>&nbsp;dirContext)</CODE>
 209
 210 <BR>
 211 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new Directory for a given path.</TD>
 212 </TR>
 213 <TR BGCOLOR="white" CLASS="TableRowColor">
 214 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 215 <CODE>&nbsp;boolean</CODE></FONT></TD>
 216 <TD><CODE><B><A HREF="../../../../org/apache/solr/core/StandardDirectoryFactory.html#exists(java.lang.String)">exists</A></B>(<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>&nbsp;path)</CODE>
 217
 218 <BR>
 219 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if a Directory exists for a given path.</TD>
 220 </TR>
 221 <TR BGCOLOR="white" CLASS="TableRowColor">
 222 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 223 <CODE>&nbsp;boolean</CODE></FONT></TD>
 224 <TD><CODE><B><A HREF="../../../../org/apache/solr/core/StandardDirectoryFactory.html#isAbsolute(java.lang.String)">isAbsolute</A></B>(<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>&nbsp;path)</CODE>
 225
 226 <BR>
 227 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 228 </TR>
 229 <TR BGCOLOR="white" CLASS="TableRowColor">
 230 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 231 <CODE>&nbsp;boolean</CODE></FONT></TD>
 232 <TD><CODE><B><A HREF="../../../../org/apache/solr/core/StandardDirectoryFactory.html#isPersistent()">isPersistent</A></B>()</CODE>
 233
 234 <BR>
 235 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 236 </TR>
 237 <TR BGCOLOR="white" CLASS="TableRowColor">
 238 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 239 <CODE>&nbsp;void</CODE></FONT></TD>
 240 <TD><CODE><B><A HREF="../../../../org/apache/solr/core/StandardDirectoryFactory.html#move(org.apache.lucene.store.Directory, org.apache.lucene.store.Directory, java.lang.String, org.apache.lucene.store.IOContext)">move</A></B>(<A HREF="http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/store/Directory.html?is-external=true" title="class or interface in org.apache.lucene.store">Directory</A>&nbsp;fromDir,
 241      <A HREF="http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/store/Directory.html?is-external=true" title="class or interface in org.apache.lucene.store">Directory</A>&nbsp;toDir,
 242      <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>&nbsp;fileName,
 243      <A HREF="http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/store/IOContext.html?is-external=true" title="class or interface in org.apache.lucene.store">IOContext</A>&nbsp;ioContext)</CODE>
 244
 245 <BR>
 246 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Override for more efficient moves.</TD>
 247 </TR>
 248 <TR BGCOLOR="white" CLASS="TableRowColor">
 249 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 250 <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>
 251 <TD><CODE><B><A HREF="../../../../org/apache/solr/core/StandardDirectoryFactory.html#normalize(java.lang.String)">normalize</A></B>(<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>&nbsp;path)</CODE>
 252
 253 <BR>
 254 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Normalize a given path.</TD>
 255 </TR>
 256 <TR BGCOLOR="white" CLASS="TableRowColor">
 257 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 258 <CODE>protected &nbsp;void</CODE></FONT></TD>
 259 <TD><CODE><B><A HREF="../../../../org/apache/solr/core/StandardDirectoryFactory.html#removeDirectory(org.apache.solr.core.CachingDirectoryFactory.CacheValue)">removeDirectory</A></B>(<A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.CacheValue.html" title="class in org.apache.solr.core">CachingDirectoryFactory.CacheValue</A>&nbsp;cacheValue)</CODE>
 260
 261 <BR>
 262 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 263 </TR>
 264 </TABLE>
 265 &nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.core.CachingDirectoryFactory"><!-- --></A>
 266 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 267 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 268 <TH ALIGN="left"><B>Methods inherited from class org.apache.solr.core.<A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html" title="class in org.apache.solr.core">CachingDirectoryFactory</A></B></TH>
 269 </TR>
 270 <TR BGCOLOR="white" CLASS="TableRowColor">
 271 <TD><CODE><A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#addCloseListener(org.apache.lucene.store.Directory, org.apache.solr.core.CachingDirectoryFactory.CloseListener)">addCloseListener</A>, <A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#close()">close</A>, <A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#doneWithDirectory(org.apache.lucene.store.Directory)">doneWithDirectory</A>, <A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#get(java.lang.String, org.apache.solr.core.DirectoryFactory.DirContext, java.lang.String)">get</A>, <A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#getLivePaths()">getLivePaths</A>, <A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#incRef(org.apache.lucene.store.Directory)">incRef</A>, <A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#init(org.apache.solr.common.util.NamedList)">init</A>, <A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#release(org.apache.lucene.store.Directory)">release</A>, <A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#remove(org.apache.lucene.store.Directory)">remove</A>, <A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#remove(org.apache.lucene.store.Directory, boolean)">remove</A>, <A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#remove(java.lang.String)">remove</A>, <A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#remove(java.lang.String, boolean)">remove</A>, <A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#stripTrailingSlash(java.lang.String)">stripTrailingSlash</A></CODE></TD>
 272 </TR>
 273 </TABLE>
 274 &nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.core.DirectoryFactory"><!-- --></A>
 275 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 276 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 277 <TH ALIGN="left"><B>Methods inherited from class org.apache.solr.core.<A HREF="../../../../org/apache/solr/core/DirectoryFactory.html" title="class in org.apache.solr.core">DirectoryFactory</A></B></TH>
 278 </TR>
 279 <TR BGCOLOR="white" CLASS="TableRowColor">
 280 <TD><CODE><A HREF="../../../../org/apache/solr/core/DirectoryFactory.html#empty(org.apache.lucene.store.Directory)">empty</A>, <A HREF="../../../../org/apache/solr/core/DirectoryFactory.html#getDataHome(org.apache.solr.core.CoreDescriptor)">getDataHome</A>, <A HREF="../../../../org/apache/solr/core/DirectoryFactory.html#searchersReserveCommitPoints()">searchersReserveCommitPoints</A>, <A HREF="../../../../org/apache/solr/core/DirectoryFactory.html#sizeOf(org.apache.lucene.store.Directory, java.lang.String)">sizeOf</A>, <A HREF="../../../../org/apache/solr/core/DirectoryFactory.html#sizeOfDirectory(org.apache.lucene.store.Directory)">sizeOfDirectory</A></CODE></TD>
 281 </TR>
 282 </TABLE>
 283 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 284 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 285 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 286 <TH ALIGN="left"><B>Methods inherited from class java.lang.<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></TH>
 287 </TR>
 288 <TR BGCOLOR="white" CLASS="TableRowColor">
 289 <TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
 290 </TR>
 291 </TABLE>
 292 &nbsp;
 293 <P>
 294
 295 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 296
 297 <A NAME="constructor_detail"><!-- --></A>
 298 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 299 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 300 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 301 <B>Constructor Detail</B></FONT></TH>
 302 </TR>
 303 </TABLE>
 304
 305 <A NAME="StandardDirectoryFactory()"><!-- --></A><H3>
 306 StandardDirectoryFactory</H3>
 307 <PRE>
 308 public <B>StandardDirectoryFactory</B>()</PRE>
 309 <DL>
 310 </DL>
 311
 312 <!-- ============ METHOD DETAIL ========== -->
 313
 314 <A NAME="method_detail"><!-- --></A>
 315 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 316 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 317 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 318 <B>Method Detail</B></FONT></TH>
 319 </TR>
 320 </TABLE>
 321
 322 <A NAME="create(java.lang.String, org.apache.solr.core.DirectoryFactory.DirContext)"><!-- --></A><H3>
 323 create</H3>
 324 <PRE>
 325 protected <A HREF="http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/store/Directory.html?is-external=true" title="class or interface in org.apache.lucene.store">Directory</A> <B>create</B>(<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>&nbsp;path,
 326                            <A HREF="../../../../org/apache/solr/core/DirectoryFactory.DirContext.html" title="enum in org.apache.solr.core">DirectoryFactory.DirContext</A>&nbsp;dirContext)
 327                     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>
 328 <DL>
 329 <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/core/DirectoryFactory.html#create(java.lang.String, org.apache.solr.core.DirectoryFactory.DirContext)">DirectoryFactory</A></CODE></B></DD>
 330 <DD>Creates a new Directory for a given path.
 331 <P>
 332 <DD><DL>
 333 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#create(java.lang.String, org.apache.solr.core.DirectoryFactory.DirContext)">create</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html" title="class in org.apache.solr.core">CachingDirectoryFactory</A></CODE></DL>
 334 </DD>
 335 <DD><DL>
 336
 337 <DT><B>Throws:</B>
 338 <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> - If there is a low-level I/O error.</DL>
 339 </DD>
 340 </DL>
 341 <HR>
 342
 343 <A NAME="normalize(java.lang.String)"><!-- --></A><H3>
 344 normalize</H3>
 345 <PRE>
 346 public <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>normalize</B>(<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>&nbsp;path)
 347                  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>
 348 <DL>
 349 <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/core/DirectoryFactory.html#normalize(java.lang.String)">DirectoryFactory</A></CODE></B></DD>
 350 <DD>Normalize a given path.
 351 <P>
 352 <DD><DL>
 353 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#normalize(java.lang.String)">normalize</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html" title="class in org.apache.solr.core">CachingDirectoryFactory</A></CODE></DL>
 354 </DD>
 355 <DD><DL>
 356 <DT><B>Parameters:</B><DD><CODE>path</CODE> - to normalize
 357 <DT><B>Returns:</B><DD>normalized path
 358 <DT><B>Throws:</B>
 359 <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> - on io error</DL>
 360 </DD>
 361 </DL>
 362 <HR>
 363
 364 <A NAME="exists(java.lang.String)"><!-- --></A><H3>
 365 exists</H3>
 366 <PRE>
 367 public boolean <B>exists</B>(<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>&nbsp;path)
 368                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>
 369 <DL>
 370 <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/core/DirectoryFactory.html#exists(java.lang.String)">DirectoryFactory</A></CODE></B></DD>
 371 <DD>Returns true if a Directory exists for a given path.
 372 <P>
 373 <DD><DL>
 374 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#exists(java.lang.String)">exists</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html" title="class in org.apache.solr.core">CachingDirectoryFactory</A></CODE></DL>
 375 </DD>
 376 <DD><DL>
 377
 378 <DT><B>Throws:</B>
 379 <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> - If there is a low-level I/O error.</DL>
 380 </DD>
 381 </DL>
 382 <HR>
 383
 384 <A NAME="isPersistent()"><!-- --></A><H3>
 385 isPersistent</H3>
 386 <PRE>
 387 public boolean <B>isPersistent</B>()</PRE>
 388 <DL>
 389 <DD><DL>
 390 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/core/DirectoryFactory.html#isPersistent()">isPersistent</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/core/DirectoryFactory.html" title="class in org.apache.solr.core">DirectoryFactory</A></CODE></DL>
 391 </DD>
 392 <DD><DL>
 393
 394 <DT><B>Returns:</B><DD>true if data is kept after close.</DL>
 395 </DD>
 396 </DL>
 397 <HR>
 398
 399 <A NAME="isAbsolute(java.lang.String)"><!-- --></A><H3>
 400 isAbsolute</H3>
 401 <PRE>
 402 public boolean <B>isAbsolute</B>(<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>&nbsp;path)</PRE>
 403 <DL>
 404 <DD><DL>
 405 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/core/DirectoryFactory.html#isAbsolute(java.lang.String)">isAbsolute</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/core/DirectoryFactory.html" title="class in org.apache.solr.core">DirectoryFactory</A></CODE></DL>
 406 </DD>
 407 <DD><DL>
 408 <DT><B>Parameters:</B><DD><CODE>path</CODE> - the path to check
 409 <DT><B>Returns:</B><DD>true if absolute, as in not relative</DL>
 410 </DD>
 411 </DL>
 412 <HR>
 413
 414 <A NAME="removeDirectory(org.apache.solr.core.CachingDirectoryFactory.CacheValue)"><!-- --></A><H3>
 415 removeDirectory</H3>
 416 <PRE>
 417 protected void <B>removeDirectory</B>(<A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.CacheValue.html" title="class in org.apache.solr.core">CachingDirectoryFactory.CacheValue</A>&nbsp;cacheValue)
 418                         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>
 419 <DL>
 420 <DD><DL>
 421 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html#removeDirectory(org.apache.solr.core.CachingDirectoryFactory.CacheValue)">removeDirectory</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/core/CachingDirectoryFactory.html" title="class in org.apache.solr.core">CachingDirectoryFactory</A></CODE></DL>
 422 </DD>
 423 <DD><DL>
 424
 425 <DT><B>Throws:</B>
 426 <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>
 427 </DD>
 428 </DL>
 429 <HR>
 430
 431 <A NAME="move(org.apache.lucene.store.Directory, org.apache.lucene.store.Directory, java.lang.String, org.apache.lucene.store.IOContext)"><!-- --></A><H3>
 432 move</H3>
 433 <PRE>
 434 public void <B>move</B>(<A HREF="http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/store/Directory.html?is-external=true" title="class or interface in org.apache.lucene.store">Directory</A>&nbsp;fromDir,
 435                  <A HREF="http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/store/Directory.html?is-external=true" title="class or interface in org.apache.lucene.store">Directory</A>&nbsp;toDir,
 436                  <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>&nbsp;fileName,
 437                  <A HREF="http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/store/IOContext.html?is-external=true" title="class or interface in org.apache.lucene.store">IOContext</A>&nbsp;ioContext)
 438           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>
 439 <DL>
 440 <DD>Override for more efficient moves.
 441
 442  Intended for use with replication - use
 443  carefully - some Directory wrappers will
 444  cache files for example.
 445
 446  This implementation works with two wrappers:
 447  NRTCachingDirectory and RateLimitedDirectoryWrapper.
 448
 449  You should first <A HREF="http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/store/Directory.html?is-external=true#sync(java.util.Collection)" title="class or interface in org.apache.lucene.store"><CODE>Directory.sync(java.util.Collection)</CODE></A> any file that will be
 450  moved or avoid cached files through settings.
 451 <P>
 452 <DD><DL>
 453 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/core/DirectoryFactory.html#move(org.apache.lucene.store.Directory, org.apache.lucene.store.Directory, java.lang.String, org.apache.lucene.store.IOContext)">move</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/core/DirectoryFactory.html" title="class in org.apache.solr.core">DirectoryFactory</A></CODE></DL>
 454 </DD>
 455 <DD><DL>
 456
 457 <DT><B>Throws:</B>
 458 <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> - If there is a low-level I/O error.</DL>
 459 </DD>
 460 </DL>
 461 <!-- ========= END OF CLASS DATA ========= -->
 462 <HR>
 463
 464
 465 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 466 <A NAME="navbar_bottom"><!-- --></A>
 467 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 468 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 469 <TR>
 470 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 471 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 472 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 473   <TR ALIGN="center" VALIGN="top">
 474   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 475   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 476   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 477   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/StandardDirectoryFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 478   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 479   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 480   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 481   </TR>
 482 </TABLE>
 483 </TD>
 484 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 485 </EM>
 486 </TD>
 487 </TR>
 488
 489 <TR>
 490 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 491 &nbsp;<A HREF="../../../../org/apache/solr/core/SolrXMLSerializer.SolrXMLDef.html" title="class in org.apache.solr.core"><B>PREV CLASS</B></A>&nbsp;
 492 &nbsp;<A HREF="../../../../org/apache/solr/core/StandardIndexReaderFactory.html" title="class in org.apache.solr.core"><B>NEXT CLASS</B></A></FONT></TD>
 493 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 494   <A HREF="../../../../index.html?org/apache/solr/core/StandardDirectoryFactory.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 495 &nbsp;<A HREF="StandardDirectoryFactory.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 496 &nbsp;<SCRIPT type="text/javascript">
 497   <!--
 498   if(window==top) {
 499     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 500   }
 501   //-->
 502 </SCRIPT>
 503 <NOSCRIPT>
 504   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
 505 </NOSCRIPT>
 506
 507
 508 </FONT></TD>
 509 </TR>
 510 <TR>
 511 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 512   SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_org.apache.solr.core.CachingDirectoryFactory">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.solr.core.CachingDirectoryFactory">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 513 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 514 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 515 </TR>
 516 </TABLE>
 517 <A NAME="skip-navbar_bottom"></A>
 518 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 519
 520 <HR>
 521
 522           <i>Copyright &copy; 2000-2013 Apache Software Foundation.  All Rights Reserved.</i>
 523           <script src='../../../../prettify.js' type='text/javascript'></script>
 524           <script type='text/javascript'>
 525             (function(){
 526               var oldonload = window.onload;
 527               if (typeof oldonload != 'function') {
 528                 window.onload = prettyPrint;
 529               } else {
 530                 window.onload = function() {
 531                   oldonload();
 532                   prettyPrint();
 533                 }
 534               }
 535             })();
 536           </script>
 537
 538 </BODY>
 539 </HTML>