|
290
|
1 /* ImageFileset -- digilib image file info class.
|
|
|
2 * Digital Image Library servlet components
|
|
|
3 * Copyright (C) 2003 Robert Casties (robcast@mail.berlios.de)
|
|
|
4 *
|
|
|
5 * This program is free software; you can
|
|
|
6 * redistribute it and/or modify it under the terms of the GNU General Public
|
|
|
7 * License as published by the Free Software Foundation; either version 2 of
|
|
|
8 * the License, or (at your option) any later version.
|
|
|
9 *
|
|
|
10 * Please read license.txt for the full details. A copy of the GPL may be
|
|
|
11 * found at http://www.gnu.org/copyleft/lgpl.html
|
|
|
12 *
|
|
|
13 * You should have received a copy of the GNU General Public License along
|
|
|
14 * with this program; if not, write to the Free Software Foundation, Inc.,
|
|
|
15 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
16 */
|
|
|
17
|
|
|
18 package digilib.io;
|
|
|
19
|
|
|
20 import java.io.File;
|
|
|
21 import java.io.IOException;
|
|
|
22 import java.util.ArrayList;
|
|
|
23 import java.util.Arrays;
|
|
|
24 import java.util.Iterator;
|
|
|
25 import java.util.ListIterator;
|
|
|
26 import java.util.Map;
|
|
|
27
|
|
|
28 import org.apache.log4j.Logger;
|
|
|
29
|
|
|
30 import digilib.image.ImageOps;
|
|
|
31 import digilib.image.ImageSize;
|
|
|
32
|
|
|
33 /**
|
|
|
34 * @author casties
|
|
|
35 */
|
|
|
36 public class ImageFileset extends DocuDirent {
|
|
|
37
|
|
|
38 /** this is an image file */
|
|
|
39 protected static int fileClass = FileOps.CLASS_IMAGE;
|
|
|
40
|
|
|
41 /** logger for this class */
|
|
|
42 private static Logger logger = Logger.getLogger(ImageFileset.class);
|
|
|
43
|
|
|
44 /** list of files (ImageFile) */
|
|
|
45 private ArrayList list = null;
|
|
|
46
|
|
|
47 /** aspect ratio (width/height) */
|
|
|
48 private float aspect = 0;
|
|
|
49
|
|
|
50 /** resolution of the biggest image (DPI) */
|
|
|
51 private float resX = 0;
|
|
|
52
|
|
|
53 /** resolution of the biggest image (DPI) */
|
|
|
54 private float resY = 0;
|
|
|
55
|
|
|
56 /**
|
|
|
57 * Creator for empty fileset.
|
|
|
58 *
|
|
|
59 *
|
|
|
60 * @param initialCapacity
|
|
|
61 */
|
|
|
62 public ImageFileset() {
|
|
|
63 list = new ArrayList();
|
|
|
64 }
|
|
|
65
|
|
|
66 /**
|
|
|
67 * Constructor with a file and hints.
|
|
|
68 *
|
|
|
69 * The hints are expected to contain 'basedirs' and 'scaledfilext' keys.
|
|
|
70 *
|
|
|
71 * @param file
|
|
|
72 * @param hints
|
|
|
73 */
|
|
|
74 public ImageFileset(File file, Map hints) {
|
|
|
75 Directory[] dirs = (Directory[]) hints.get(FileOps.HINT_BASEDIRS);
|
|
|
76 int nb = dirs.length;
|
|
|
77 list = new ArrayList(nb);
|
|
|
78 parent = dirs[0];
|
|
|
79 fill(dirs, file, hints);
|
|
|
80 }
|
|
|
81
|
|
|
82 /**
|
|
|
83 * Adds an ImageFile to this Fileset.
|
|
|
84 *
|
|
|
85 * The files should be added in the order of higher to lower resolutions.
|
|
|
86 * The first file is considered the hires "original".
|
|
|
87 *
|
|
|
88 *
|
|
|
89 * @param f
|
|
|
90 * file to add
|
|
|
91 * @return true (always)
|
|
|
92 */
|
|
|
93 public boolean add(ImageFile f) {
|
|
|
94 f.setParent(this);
|
|
|
95 return list.add(f);
|
|
|
96 }
|
|
|
97
|
|
|
98 /**
|
|
|
99 * The number of image files in this Fileset.
|
|
|
100 *
|
|
|
101 *
|
|
|
102 * @return number of image files
|
|
|
103 */
|
|
|
104 public int size() {
|
|
|
105 return (list != null) ? list.size() : 0;
|
|
|
106 }
|
|
|
107
|
|
|
108 /**
|
|
|
109 * Gets the default File.
|
|
|
110 *
|
|
|
111 */
|
|
|
112 public File getFile() {
|
|
|
113 return (list != null) ? ((ImageFile) list.get(0)).getFile() : null;
|
|
|
114 }
|
|
|
115
|
|
|
116 /**
|
|
|
117 * Get the ImageFile at the index.
|
|
|
118 *
|
|
|
119 *
|
|
|
120 * @param index
|
|
|
121 * @return
|
|
|
122 */
|
|
|
123 public ImageFile get(int index) {
|
|
|
124 return (ImageFile) list.get(index);
|
|
|
125 }
|
|
|
126
|
|
|
127 /**
|
|
|
128 * Get the next smaller ImageFile than the given size.
|
|
|
129 *
|
|
|
130 * Returns the ImageFile from the set that has a width and height smaller or
|
|
|
131 * equal the given size. Returns null if there isn't any smaller image.
|
|
|
132 * Needs DocuInfo instance to checkFile().
|
|
|
133 *
|
|
|
134 *
|
|
|
135 * @param size
|
|
|
136 * @param info
|
|
|
137 * @return
|
|
|
138 */
|
|
|
139 public ImageFile getNextSmaller(ImageSize size) {
|
|
|
140 for (Iterator i = getHiresIterator(); i.hasNext();) {
|
|
|
141 ImageFile f = (ImageFile) i.next();
|
|
|
142 try {
|
|
|
143 if (!f.isChecked()) {
|
|
|
144 ImageOps.checkFile(f);
|
|
|
145 }
|
|
|
146 if (f.getSize().isTotallySmallerThan(size)) {
|
|
|
147 return f;
|
|
|
148 }
|
|
|
149 } catch (IOException e) {
|
|
|
150 }
|
|
|
151 }
|
|
|
152 return null;
|
|
|
153 }
|
|
|
154
|
|
|
155 /**
|
|
|
156 * Get the next bigger ImageFile than the given size.
|
|
|
157 *
|
|
|
158 * Returns the ImageFile from the set that has a width or height bigger or
|
|
|
159 * equal the given size. Returns null if there isn't any bigger image. Needs
|
|
|
160 * DocuInfo instance to checkFile().
|
|
|
161 *
|
|
|
162 *
|
|
|
163 * @param size
|
|
|
164 * @param info
|
|
|
165 * @return
|
|
|
166 */
|
|
|
167 public ImageFile getNextBigger(ImageSize size) {
|
|
|
168 for (ListIterator i = getLoresIterator(); i.hasPrevious();) {
|
|
|
169 ImageFile f = (ImageFile) i.previous();
|
|
|
170 try {
|
|
|
171 if (!f.isChecked()) {
|
|
|
172 ImageOps.checkFile(f);
|
|
|
173 }
|
|
|
174 if (f.getSize().isBiggerThan(size)) {
|
|
|
175 return f;
|
|
|
176 }
|
|
|
177 } catch (IOException e) {
|
|
|
178 }
|
|
|
179 }
|
|
|
180 return null;
|
|
|
181 }
|
|
|
182
|
|
|
183 /**
|
|
|
184 * Returns the biggest ImageFile in the set.
|
|
|
185 *
|
|
|
186 *
|
|
|
187 * @return
|
|
|
188 */
|
|
|
189 public ImageFile getBiggest() {
|
|
|
190 return this.get(0);
|
|
|
191 }
|
|
|
192
|
|
|
193 /**
|
|
|
194 * Returns the biggest ImageFile in the set.
|
|
|
195 *
|
|
|
196 *
|
|
|
197 * @return
|
|
|
198 */
|
|
|
199 public ImageFile getSmallest() {
|
|
|
200 return this.get(this.size() - 1);
|
|
|
201 }
|
|
|
202
|
|
|
203 /**
|
|
|
204 * Get an Iterator for this Fileset starting at the highest resolution
|
|
|
205 * images.
|
|
|
206 *
|
|
|
207 *
|
|
|
208 * @return
|
|
|
209 */
|
|
|
210 public ListIterator getHiresIterator() {
|
|
|
211 return list.listIterator();
|
|
|
212 }
|
|
|
213
|
|
|
214 /**
|
|
|
215 * Get an Iterator for this Fileset starting at the lowest resolution
|
|
|
216 * images.
|
|
|
217 *
|
|
|
218 * The Iterator starts at the last element, so you have to use it backwards
|
|
|
219 * with hasPrevious() and previous().
|
|
|
220 *
|
|
|
221 *
|
|
|
222 * @return
|
|
|
223 */
|
|
|
224 public ListIterator getLoresIterator() {
|
|
|
225 return list.listIterator(list.size());
|
|
|
226 }
|
|
|
227
|
|
|
228 /**
|
|
|
229 * Fill the ImageFileset with files from different base directories.
|
|
|
230 *
|
|
|
231 *
|
|
|
232 * @param dirs
|
|
|
233 * list of base directories
|
|
|
234 * @param fl
|
|
|
235 * file (from first base dir)
|
|
|
236 * @param hints
|
|
|
237 *
|
|
|
238 */
|
|
|
239 void fill(Directory[] dirs, File fl, Map hints) {
|
|
|
240 String scalext = (String) hints.get(FileOps.HINT_FILEEXT);
|
|
|
241 int nb = dirs.length;
|
|
|
242 String fn = fl.getName();
|
|
|
243 String baseFn = FileOps.basename(fn);
|
|
|
244 // add the first ImageFile to the ImageFileset
|
|
|
245 add(new ImageFile(fn, this, parent));
|
|
|
246 // iterate the remaining base directories
|
|
|
247 for (int dirIdx = 1; dirIdx < nb; dirIdx++) {
|
|
|
248 if (dirs[dirIdx] == null) {
|
|
|
249 continue;
|
|
|
250 }
|
|
|
251 // read the directory
|
|
|
252 if (dirs[dirIdx].getFilenames() == null) {
|
|
|
253 dirs[dirIdx].readDir();
|
|
|
254 }
|
|
|
255 String[] dirFiles = dirs[dirIdx].getFilenames();
|
|
|
256 // try the same filename as the original
|
|
|
257 int fileIdx = Arrays.binarySearch(dirFiles, fn);
|
|
|
258 if (fileIdx < 0) {
|
|
|
259 // try closest matches without extension
|
|
|
260 fileIdx = -fileIdx - 1;
|
|
|
261 // try idx
|
|
|
262 if ((fileIdx < dirFiles.length)
|
|
|
263 && (FileOps.basename(dirFiles[fileIdx]).equals(baseFn))) {
|
|
|
264 // idx ok
|
|
|
265 } else if ((fileIdx > 0)
|
|
|
266 && (FileOps.basename(dirFiles[fileIdx - 1])
|
|
|
267 .equals(baseFn))) {
|
|
|
268 // idx-1 ok
|
|
|
269 fileIdx = fileIdx - 1;
|
|
|
270 } else if ((fileIdx+1 < dirFiles.length)
|
|
|
271 && (FileOps.basename(dirFiles[fileIdx + 1])
|
|
|
272 .equals(baseFn))) {
|
|
|
273 // idx+1 ok
|
|
|
274 fileIdx = fileIdx + 1;
|
|
|
275 } else {
|
|
|
276 // basename doesn't match
|
|
|
277 continue;
|
|
|
278 }
|
|
|
279 }
|
|
|
280 if (FileOps.classForFilename(dirFiles[fileIdx]) == FileOps.CLASS_IMAGE) {
|
|
|
281 /* logger.debug("adding file " + dirFiles[fileIdx]
|
|
|
282 + " to Fileset " + this.getName()); */
|
|
|
283 add(new ImageFile(dirFiles[fileIdx], this, dirs[dirIdx]));
|
|
|
284 }
|
|
|
285 }
|
|
|
286 }
|
|
|
287
|
|
|
288 /**
|
|
|
289 * Checks metadata and sets resolution in resX and resY.
|
|
|
290 *
|
|
|
291 */
|
|
|
292 public void checkMeta() {
|
|
|
293 if (metaChecked) {
|
|
|
294 return;
|
|
|
295 }
|
|
|
296 if (fileMeta == null) {
|
|
|
297 // try to read metadata file
|
|
|
298 readMeta();
|
|
|
299 if (fileMeta == null) {
|
|
|
300 // try directory metadata
|
|
|
301 ((DocuDirectory) parent).checkMeta();
|
|
|
302 if (((DocuDirectory) parent).getDirMeta() != null) {
|
|
|
303 fileMeta = ((DocuDirectory) parent).getDirMeta();
|
|
|
304 } else {
|
|
|
305 // try parent directory metadata
|
|
|
306 DocuDirectory gp = (DocuDirectory) parent.getParent();
|
|
|
307 if (gp != null) {
|
|
|
308 gp.checkMeta();
|
|
|
309 if (gp.getDirMeta() != null) {
|
|
|
310 fileMeta = gp.getDirMeta();
|
|
|
311 } else {
|
|
|
312 // no metadata available
|
|
|
313 metaChecked = true;
|
|
|
314 return;
|
|
|
315 }
|
|
|
316 }
|
|
|
317 }
|
|
|
318 }
|
|
|
319 }
|
|
|
320 metaChecked = true;
|
|
|
321 String s;
|
|
|
322 float dpi = 0;
|
|
|
323 float dpix = 0;
|
|
|
324 float dpiy = 0;
|
|
|
325 float sizex = 0;
|
|
|
326 float sizey = 0;
|
|
|
327 float pixx = 0;
|
|
|
328 float pixy = 0;
|
|
|
329 // DPI is valid for X and Y
|
|
|
330 if (fileMeta.containsKey("original-dpi")) {
|
|
|
331 try {
|
|
|
332 dpi = Float.parseFloat((String) fileMeta.get("original-dpi"));
|
|
|
333 } catch (NumberFormatException e) {
|
|
|
334 }
|
|
|
335 if (dpi != 0) {
|
|
|
336 resX = dpi;
|
|
|
337 resY = dpi;
|
|
|
338 return;
|
|
|
339 }
|
|
|
340 }
|
|
|
341 // DPI-X and DPI-Y
|
|
|
342 if (fileMeta.containsKey("original-dpi-x")
|
|
|
343 && fileMeta.containsKey("original-dpi-y")) {
|
|
|
344 try {
|
|
|
345 dpix = Float.parseFloat((String) fileMeta
|
|
|
346 .get("original-dpi-x"));
|
|
|
347 dpiy = Float.parseFloat((String) fileMeta
|
|
|
348 .get("original-dpi-y"));
|
|
|
349 } catch (NumberFormatException e) {
|
|
|
350 }
|
|
|
351 if ((dpix != 0) && (dpiy != 0)) {
|
|
|
352 resX = dpix;
|
|
|
353 resY = dpiy;
|
|
|
354 return;
|
|
|
355 }
|
|
|
356 }
|
|
|
357 // SIZE-X and SIZE-Y and PIXEL-X and PIXEL-Y
|
|
|
358 if (fileMeta.containsKey("original-size-x")
|
|
|
359 && fileMeta.containsKey("original-size-y")
|
|
|
360 && fileMeta.containsKey("original-pixel-x")
|
|
|
361 && fileMeta.containsKey("original-pixel-y")) {
|
|
|
362 try {
|
|
|
363 sizex = Float.parseFloat((String) fileMeta
|
|
|
364 .get("original-size-x"));
|
|
|
365 sizey = Float.parseFloat((String) fileMeta
|
|
|
366 .get("original-size-y"));
|
|
|
367 pixx = Float.parseFloat((String) fileMeta
|
|
|
368 .get("original-pixel-x"));
|
|
|
369 pixy = Float.parseFloat((String) fileMeta
|
|
|
370 .get("original-pixel-y"));
|
|
|
371 } catch (NumberFormatException e) {
|
|
|
372 }
|
|
|
373 if ((sizex != 0) && (sizey != 0) && (pixx != 0) && (pixy != 0)) {
|
|
|
374 resX = pixx / (sizex * 100 / 2.54f);
|
|
|
375 resY = pixy / (sizey * 100 / 2.54f);
|
|
|
376 return;
|
|
|
377 }
|
|
|
378 }
|
|
|
379 }
|
|
|
380
|
|
|
381 /**
|
|
|
382 * @return
|
|
|
383 */
|
|
|
384 public float getResX() {
|
|
|
385 return resX;
|
|
|
386 }
|
|
|
387
|
|
|
388 /**
|
|
|
389 * @return
|
|
|
390 */
|
|
|
391 public float getResY() {
|
|
|
392 return resY;
|
|
|
393 }
|
|
|
394
|
|
|
395 /**
|
|
|
396 * Sets the aspect ratio from an ImageSize.
|
|
|
397 *
|
|
|
398 *
|
|
|
399 * @param f
|
|
|
400 */
|
|
|
401 public void setAspect(ImageSize s) {
|
|
|
402 aspect = s.getAspect();
|
|
|
403 }
|
|
|
404
|
|
|
405 /**
|
|
|
406 * Returns the aspect ratio.
|
|
|
407 *
|
|
|
408 * Aspect ratio is (width/height). So it's <1 for portrait and >1 for
|
|
|
409 * landscape.
|
|
|
410 *
|
|
|
411 *
|
|
|
412 * @return
|
|
|
413 */
|
|
|
414 public float getAspect() {
|
|
|
415 return aspect;
|
|
|
416 }
|
|
|
417
|
|
|
418 } |
