annotate servlet/src/digilib/io/DocuDirCache.java @ 95:a82150544f4a

New version 1.8b4. Uses new Collection classes.
author robcast
date Mon, 17 Mar 2003 16:07:05 +0100
parents a398fc09ba71
children 226624784fe3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
1 /* DocuDirCache.java
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
2
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
3 Digital Image Library servlet components
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
4
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
5 Copyright (C) 2003 Robert Casties (robcast@mail.berlios.de)
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
6
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
7 This program is free software; you can redistribute it and/or modify it
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
9 Free Software Foundation; either version 2 of the License, or (at your
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
10 option) any later version.
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
11
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
12 Please read license.txt for the full details. A copy of the GPL
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
13 may be found at http://www.gnu.org/copyleft/lgpl.html
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
14
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
16 along with this program; if not, write to the Free Software
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
18
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
19 * Created on 03.03.2003
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
20 */
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
21
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
22 package digilib.io;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
23
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
24 import java.io.File;
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
25 import java.util.HashMap;
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
26
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
27 /**
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
28 * @author casties
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
29 */
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
30 public class DocuDirCache {
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
31
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
32 // HashMap of directories
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
33 private HashMap map = null;
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
34 // names of base directories
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
35 private String[] baseDirNames = null;
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
36 // number of files in the whole cache (approximate)
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
37 private long numFiles = 0;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
38 // number of cache hits
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
39 private long hits = 0;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
40 // number of cache misses
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
41 private long misses = 0;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
42
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
43 /** Constructor with array of base directory names.
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
44 *
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
45 * @param bd base directory names
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
46 */
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
47 public DocuDirCache(String[] bd) {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
48 baseDirNames = bd;
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
49 map = new HashMap();
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
50 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
51
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
52 /** The number of directories in the cache.
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
53 * @return
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
54 */
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
55 public int size() {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
56 return (map != null) ? map.size() : 0;
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
57 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
58
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
59 /** Add a DocuDirectory to the cache.
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
60 *
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
61 * @param newdir
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
62 */
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
63 public void put(DocuDirectory newdir) {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
64 String s = newdir.getDirName();
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
65 if (map.containsKey(s)) {
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
66 System.out.println("Baah, duplicate key in DocuDirectory.put!");
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
67 } else {
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
68 map.put(s, newdir);
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
69 numFiles += newdir.size();
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
70 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
71 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
72
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
73 /** Returns the DocuFileset with the pathname <code>fn</code> and the
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
74 * index <code>in</code>.
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
75 *
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
76 * If <code>fn</code> is a file then the corresponding Fileset is
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
77 * returned and the index is ignored.
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
78 *
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
79 * @param fn digilib pathname
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
80 * @param in file index
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
81 * @return
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
82 */
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
83 public DocuFileset getFileset(String fn, int in) {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
84 DocuDirectory dd;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
85 // file number is 1-based, vector index is 0-based
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
86 int n = in - 1;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
87 // first, assume fn is a directory and look in the cache
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
88 dd = (DocuDirectory) map.get(fn);
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
89 if (dd == null) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
90 // cache miss
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
91 misses++;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
92 // see if it's a directory
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
93 File f = new File(baseDirNames[0] + fn);
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
94 if (f.isDirectory()) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
95 dd = new DocuDirectory(fn, baseDirNames);
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
96 if (dd.isValid()) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
97 // add to the cache
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
98 put(dd);
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
99 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
100 } else {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
101 // maybe it's a file
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
102 if (f.canRead()) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
103 // get the parent directory
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
104 String d = fn.substring(0, fn.lastIndexOf(File.separator));
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
105 // try it in the cache
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
106 dd = (DocuDirectory) map.get(d);
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
107 if (dd == null) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
108 // try to read from disk
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
109 dd = new DocuDirectory(d, baseDirNames);
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
110 if (dd.isValid()) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
111 // add to the cache
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
112 put(dd);
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
113 } else {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
114 // invalid path
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
115 return null;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
116 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
117 } else {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
118 // not a real cache miss then
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
119 misses--;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
120 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
121 // get the file's index
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
122 n = dd.indexOf(f.getName());
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
123 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
124 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
125 } else {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
126 // cache hit
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
127 hits++;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
128 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
129 dd.refresh();
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
130 if (dd.isValid()) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
131 try {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
132 return dd.get(n);
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
133 } catch (ArrayIndexOutOfBoundsException e) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
134 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
135 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
136 return null;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
137 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
138
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
139 /** Returns the DocuDirectory indicated by the pathname <code>fn</code>.
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
140 *
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
141 * If <code>fn</code> is a file then its parent directory is returned.
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
142 *
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
143 * @param fn digilib pathname
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
144 * @return
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
145 */
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
146 public DocuDirectory getDirectory(String fn) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
147 DocuDirectory dd;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
148 // first, assume fn is a directory and look in the cache
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
149 dd = (DocuDirectory) map.get(fn);
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
150 if (dd == null) {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
151 // cache miss
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
152 misses++;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
153 // see if it's a directory
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
154 File f = new File(baseDirNames[0] + fn);
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
155 if (f.isDirectory()) {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
156 dd = new DocuDirectory(fn, baseDirNames);
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
157 if (dd.isValid()) {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
158 // add to the cache
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
159 put(dd);
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
160 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
161 } else {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
162 // maybe it's a file
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
163 if (f.canRead()) {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
164 // try the parent directory in the cache
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
165 dd = (DocuDirectory) map.get(f.getParent());
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
166 if (dd == null) {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
167 // try to read from disk
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
168 dd = new DocuDirectory(f.getParent(), baseDirNames);
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
169 if (dd.isValid()) {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
170 // add to the cache
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
171 put(dd);
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
172 } else {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
173 // invalid path
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
174 return null;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
175 }
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
176 } else {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
177 // not a real cache miss then
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
178 misses--;
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
179 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
180 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
181 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
182 } else {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
183 // cache hit
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
184 hits++;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
185 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
186 dd.refresh();
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
187 if (dd.isValid()) {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
188 return dd;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
189 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
190 return null;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
191 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
192
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
193 /**
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
194 * @return String[]
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
195 */
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
196 public String[] getBaseDirNames() {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
197 return baseDirNames;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
198 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
199
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
200 /**
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
201 * @return long
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
202 */
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
203 public long getNumFiles() {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
204 return numFiles;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
205 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
206
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
207 /**
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
208 * Sets the baseDirNames.
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
209 * @param baseDirNames The baseDirNames to set
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
210 */
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
211 public void setBaseDirNames(String[] baseDirNames) {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
212 this.baseDirNames = baseDirNames;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
213 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
214
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
215 /**
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
216 * @return long
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
217 */
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
218 public long getHits() {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
219 return hits;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
220 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
221
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
222 /**
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
223 * @return long
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
224 */
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
225 public long getMisses() {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
226 return misses;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
227 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
228
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
229 }