Mercurial > hg > digilib-old
annotate servlet/src/digilib/io/DocuDirCache.java @ 241:bc30dea2bb2e
*** empty log message ***
| author | robcast |
|---|---|
| date | Wed, 21 Jul 2004 17:25:04 +0200 |
| parents | f8c82fea551a |
| children | aaf6eace011d |
| rev | line source |
|---|---|
| 176 | 1 /* |
| 2 * DocuDirCache.java | |
| 3 * | |
| 4 * Digital Image Library servlet components | |
| 5 * | |
| 6 * Copyright (C) 2003 Robert Casties (robcast@mail.berlios.de) | |
| 7 * | |
| 8 * This program is free software; you can redistribute it and/or modify it | |
| 9 * under the terms of the GNU General Public License as published by the Free | |
| 10 * Software Foundation; either version 2 of the License, or (at your option) | |
| 11 * any later version. | |
| 12 * | |
| 13 * Please read license.txt for the full details. A copy of the GPL may be found | |
| 14 * at http://www.gnu.org/copyleft/lgpl.html | |
| 15 * | |
| 16 * You should have received a copy of the GNU General Public License along with | |
| 17 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple | |
| 18 * Place, Suite 330, Boston, MA 02111-1307 USA | |
| 19 * | |
| 86 | 20 * Created on 03.03.2003 |
| 21 */ | |
| 22 | |
| 23 package digilib.io; | |
| 24 | |
| 25 import java.io.File; | |
| 91 | 26 import java.util.HashMap; |
| 159 | 27 import java.util.Iterator; |
| 28 import java.util.LinkedList; | |
| 29 import java.util.List; | |
| 86 | 30 |
| 181 | 31 import org.apache.log4j.Logger; |
| 32 | |
| 86 | 33 /** |
| 34 * @author casties | |
| 35 */ | |
| 91 | 36 public class DocuDirCache { |
| 86 | 37 |
| 181 | 38 /** general logger for this class */ |
| 39 protected Logger logger = Logger.getLogger(this.getClass()); | |
| 159 | 40 /** HashMap of directories */ |
| 176 | 41 protected HashMap map = null; |
| 159 | 42 /** names of base directories */ |
| 86 | 43 private String[] baseDirNames = null; |
| 159 | 44 /** array of allowed file classes (image/text) */ |
| 45 private int[] fileClasses = null; | |
| 46 /** number of files in the whole cache (approximate) */ | |
| 86 | 47 private long numFiles = 0; |
| 159 | 48 /** number of cache hits */ |
| 86 | 49 private long hits = 0; |
| 159 | 50 /** number of cache misses */ |
| 86 | 51 private long misses = 0; |
| 52 | |
| 176 | 53 /** |
| 54 * Constructor with array of base directory names and file classes. | |
| 55 * | |
| 56 * @param bd | |
| 57 * base directory names | |
| 159 | 58 */ |
| 59 public DocuDirCache(String[] bd, int[] fileClasses) { | |
| 60 baseDirNames = bd; | |
| 61 map = new HashMap(); | |
| 62 this.fileClasses = fileClasses; | |
| 63 } | |
| 176 | 64 /** |
| 65 * Constructor with array of base directory names. | |
| 66 * | |
| 67 * @param bd | |
| 68 * base directory names | |
| 86 | 69 */ |
| 70 public DocuDirCache(String[] bd) { | |
| 71 baseDirNames = bd; | |
| 91 | 72 map = new HashMap(); |
| 159 | 73 // default file class is CLASS_IMAGE |
| 74 fileClasses = new int[1]; | |
| 75 fileClasses[0] = FileOps.CLASS_IMAGE; | |
| 91 | 76 } |
| 77 | |
| 176 | 78 /** |
| 79 * The number of directories in the cache. | |
| 80 * | |
| 91 | 81 * @return |
| 82 */ | |
| 83 public int size() { | |
| 84 return (map != null) ? map.size() : 0; | |
| 86 | 85 } |
| 86 | |
| 176 | 87 /** |
| 88 * Add a DocuDirectory to the cache. | |
| 86 | 89 * |
| 90 * @param newdir | |
| 91 */ | |
| 92 public void put(DocuDirectory newdir) { | |
| 93 String s = newdir.getDirName(); | |
| 91 | 94 if (map.containsKey(s)) { |
| 197 | 95 logger.warn("Duplicate key in DocuDirCache.put -- ignoring!"); |
| 86 | 96 } else { |
| 91 | 97 map.put(s, newdir); |
| 86 | 98 numFiles += newdir.size(); |
| 99 } | |
| 100 } | |
| 101 | |
| 176 | 102 /** |
| 103 * Add a directory to the cache and check its parents. | |
| 151 | 104 * |
| 105 * @param newDir | |
| 106 */ | |
| 107 public void putDir(DocuDirectory newDir) { | |
| 108 put(newDir); | |
| 109 String parent = newDir.getParentDirName(); | |
| 110 if (parent != null) { | |
| 111 // check the parent in the cache | |
| 176 | 112 DocuDirectory pd = (DocuDirectory) map.get(parent); |
| 151 | 113 if (pd == null) { |
| 114 // the parent is unknown | |
| 115 pd = new DocuDirectory(parent, this); | |
| 116 putDir(pd); | |
| 117 } | |
| 118 newDir.setParent(pd); | |
| 119 } | |
| 120 } | |
| 121 | |
| 176 | 122 /** |
| 123 * Get a list with all children of a directory. | |
| 159 | 124 * |
| 176 | 125 * Returns a List of DocuDirectory's. Returns an empty List if the |
| 126 * directory has no children. If recurse is false then only direct children | |
| 127 * are returned. | |
| 159 | 128 * |
| 129 * @param dirname | |
| 176 | 130 * @param recurse |
| 131 * find all children and their children. | |
| 159 | 132 * @return |
| 133 */ | |
| 134 public List getChildren(String dirname, boolean recurse) { | |
| 135 List l = new LinkedList(); | |
| 176 | 136 for (Iterator i = map.keySet().iterator(); i.hasNext();) { |
| 209 | 137 String n = (String) i.next(); |
| 138 DocuDirectory dd = (DocuDirectory) map.get(n); | |
| 159 | 139 if (recurse) { |
| 140 if (dd.getDirName().startsWith(dirname)) { | |
| 141 l.add(dd); | |
| 142 } | |
| 143 } else { | |
| 144 if (dd.getParentDirName().equals(dirname)) { | |
| 145 l.add(dd); | |
| 146 } | |
| 147 } | |
| 148 } | |
| 149 return l; | |
| 150 } | |
| 151 | |
| 176 | 152 /** |
| 187 | 153 * Returns the DocuDirent with the pathname <code>fn</code> and the |
| 159 | 154 * index <code>in</code> and the class <code>fc</code>. |
| 91 | 155 * |
| 187 | 156 * If <code>fn</code> is a file then the corresponding DocuDirent is |
| 91 | 157 * returned and the index is ignored. |
| 158 * | |
| 176 | 159 * @param fn |
| 160 * digilib pathname | |
| 161 * @param in | |
| 162 * file index | |
| 163 * @return | |
| 91 | 164 */ |
| 159 | 165 public DocuDirent getFile(String fn, int in, int fc) { |
| 86 | 166 DocuDirectory dd; |
| 167 // file number is 1-based, vector index is 0-based | |
| 168 int n = in - 1; | |
| 169 // first, assume fn is a directory and look in the cache | |
| 91 | 170 dd = (DocuDirectory) map.get(fn); |
| 171 if (dd == null) { | |
| 172 // cache miss | |
| 173 misses++; | |
| 176 | 174 /* |
| 175 * see if it's a directory | |
| 176 */ | |
| 152 | 177 File f = new File(baseDirNames[0], fn); |
| 91 | 178 if (f.isDirectory()) { |
| 151 | 179 dd = new DocuDirectory(fn, this); |
| 91 | 180 if (dd.isValid()) { |
| 181 // add to the cache | |
| 151 | 182 putDir(dd); |
| 91 | 183 } |
| 184 } else { | |
| 176 | 185 /* |
| 186 * maybe it's a file | |
| 187 */ | |
| 188 // get the parent directory string (like we store it in the | |
| 189 // cache) | |
| 190 String d = fn.substring(0, fn.lastIndexOf("/")); | |
| 191 // try it in the cache | |
| 192 dd = (DocuDirectory) map.get(d); | |
| 193 if (dd == null) { | |
| 194 // try to read from disk | |
| 195 dd = new DocuDirectory(d, this); | |
| 196 if (dd.isValid()) { | |
| 197 // add to the cache | |
| 198 putDir(dd); | |
| 91 | 199 } else { |
| 176 | 200 // invalid path |
| 201 return null; | |
| 91 | 202 } |
|
99
226624784fe3
Small bug lead to null pointer exception when directory doesn't exist.
robcast
parents:
91
diff
changeset
|
203 } else { |
| 176 | 204 // it was not a real cache miss |
| 205 misses--; | |
| 91 | 206 } |
| 176 | 207 // get the file's index |
| 208 n = dd.indexOf(f.getName(), fc); | |
| 91 | 209 } |
| 210 } else { | |
| 211 // cache hit | |
| 212 hits++; | |
| 213 } | |
| 214 dd.refresh(); | |
| 215 if (dd.isValid()) { | |
| 216 try { | |
| 159 | 217 return dd.get(n, fc); |
| 187 | 218 } catch (IndexOutOfBoundsException e) { |
| 91 | 219 } |
| 220 } | |
| 221 return null; | |
| 222 } | |
| 223 | |
| 176 | 224 /** |
| 225 * Returns the DocuDirectory indicated by the pathname <code>fn</code>. | |
| 91 | 226 * |
| 227 * If <code>fn</code> is a file then its parent directory is returned. | |
| 228 * | |
| 176 | 229 * @param fn |
| 230 * digilib pathname | |
| 91 | 231 * @return |
| 232 */ | |
| 233 public DocuDirectory getDirectory(String fn) { | |
| 234 DocuDirectory dd; | |
| 235 // first, assume fn is a directory and look in the cache | |
| 236 dd = (DocuDirectory) map.get(fn); | |
| 86 | 237 if (dd == null) { |
| 238 // cache miss | |
| 239 misses++; | |
| 240 // see if it's a directory | |
| 152 | 241 File f = new File(baseDirNames[0], fn); |
| 86 | 242 if (f.isDirectory()) { |
| 151 | 243 dd = new DocuDirectory(fn, this); |
| 86 | 244 if (dd.isValid()) { |
| 245 // add to the cache | |
| 151 | 246 putDir(dd); |
| 86 | 247 } |
| 248 } else { | |
| 249 // maybe it's a file | |
| 250 if (f.canRead()) { | |
| 251 // try the parent directory in the cache | |
| 91 | 252 dd = (DocuDirectory) map.get(f.getParent()); |
| 86 | 253 if (dd == null) { |
| 254 // try to read from disk | |
| 151 | 255 dd = new DocuDirectory(f.getParent(), this); |
| 86 | 256 if (dd.isValid()) { |
| 257 // add to the cache | |
| 151 | 258 putDir(dd); |
| 86 | 259 } else { |
| 260 // invalid path | |
| 261 return null; | |
| 262 } | |
| 91 | 263 } else { |
| 264 // not a real cache miss then | |
| 265 misses--; | |
| 86 | 266 } |
|
99
226624784fe3
Small bug lead to null pointer exception when directory doesn't exist.
robcast
parents:
91
diff
changeset
|
267 } else { |
|
226624784fe3
Small bug lead to null pointer exception when directory doesn't exist.
robcast
parents:
91
diff
changeset
|
268 // it's not even a file :-( |
|
226624784fe3
Small bug lead to null pointer exception when directory doesn't exist.
robcast
parents:
91
diff
changeset
|
269 return null; |
| 86 | 270 } |
| 271 } | |
| 272 } else { | |
| 273 // cache hit | |
| 274 hits++; | |
| 275 } | |
| 276 dd.refresh(); | |
| 277 if (dd.isValid()) { | |
| 278 return dd; | |
| 279 } | |
| 280 return null; | |
| 281 } | |
| 282 | |
| 283 /** | |
| 284 * @return String[] | |
| 285 */ | |
| 286 public String[] getBaseDirNames() { | |
| 287 return baseDirNames; | |
| 288 } | |
| 289 | |
| 290 /** | |
| 291 * @return long | |
| 292 */ | |
| 293 public long getNumFiles() { | |
| 294 return numFiles; | |
| 295 } | |
| 296 | |
| 297 /** | |
| 298 * Sets the baseDirNames. | |
| 176 | 299 * |
| 300 * @param baseDirNames | |
| 301 * The baseDirNames to set | |
| 86 | 302 */ |
| 303 public void setBaseDirNames(String[] baseDirNames) { | |
| 304 this.baseDirNames = baseDirNames; | |
| 305 } | |
| 306 | |
| 307 /** | |
| 308 * @return long | |
| 309 */ | |
| 310 public long getHits() { | |
| 311 return hits; | |
| 312 } | |
| 313 | |
| 314 /** | |
| 315 * @return long | |
| 316 */ | |
| 317 public long getMisses() { | |
| 318 return misses; | |
| 319 } | |
| 320 | |
| 159 | 321 /** |
| 322 * @return | |
| 323 */ | |
| 324 public int[] getFileClasses() { | |
| 325 return fileClasses; | |
| 326 } | |
| 327 | |
| 328 /** | |
| 329 * @param fileClasses | |
| 330 */ | |
| 331 public void setFileClasses(int[] fileClasses) { | |
| 332 this.fileClasses = fileClasses; | |
| 333 } | |
| 176 | 334 |
| 86 | 335 } |