annotate servlet/src/digilib/io/DocuFileset.java @ 103:0e49645f98c8

Servlet V1.9b2 Fixes error in rotation for ImageLoader DocuImage.
author robcast
date Mon, 12 May 2003 22:33:44 +0200
parents a398fc09ba71
children a32e8c80e2f2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
1 /* DocuFileset -- digilib image file info class.
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 */
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
20 package digilib.io;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
21
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
22 import java.util.ArrayList;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
23 import java.util.HashMap;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
24 import java.util.ListIterator;
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
25
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
26 /**
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
27 * @author casties
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
28 */
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
29 public class DocuFileset {
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
30
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
31 // list of files
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
32 private ArrayList list = null;
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
33 // metadata
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
34 private HashMap fileMeta = null;
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
35 // parent directory
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
36 private DocuDirectory parent = null;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
37
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
38 /*
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
39 * constructors
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
40 */
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
41
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
42 public DocuFileset(int initialCapacity) {
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
43 list = new ArrayList(initialCapacity);
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
44 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
45
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
46 /*
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
47 * other stuff
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
48 */
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
49
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
50 /** Adds a DocuFile to this Fileset.
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
51 *
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
52 * The files should be added in the order of lower resolutions. The first
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
53 * file is considered the hires "original".
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
54 *
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
55 * @param f file to add
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
56 * @return true (always)
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
57 */
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
58 public boolean add(DocuFile f) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
59 f.setParent(this);
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
60 return list.add(f);
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
61 }
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
62
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
63 /** The number of image files in this Fileset.
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
64 *
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
65 * @return number of image files
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
66 */
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
67 public int size() {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
68 return (list != null) ? list.size() : 0;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
69 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
70
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
71 /** Get the DocuFile at the index.
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
72 *
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
73 * @param index
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
74 * @return
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
75 */
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
76 public DocuFile get(int index) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
77 return (DocuFile) list.get(index);
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
78 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
79
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
80
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
81 /** Get an Iterator for this Fileset starting at the highest resolution
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
82 * images.
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
83 *
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
84 * @return
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
85 */
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
86 public ListIterator getHiresIterator() {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
87 return list.listIterator();
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
88 }
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
89
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
90 /** Get an Iterator for this Fileset starting at the lowest resolution
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
91 * images.
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
92 *
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
93 * The Iterator starts at the last element, so you have to use it backwards
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
94 * with hasPrevious() and previous().
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
95 *
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
96 * @return
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
97 */
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
98 public ListIterator getLoresIterator() {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
99 return list.listIterator(list.size());
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
100 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
101
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
102 /** Reads meta-data for this Fileset if there is any.
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
103 * (not yet implemented)
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
104 */
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
105 public void checkMeta() {
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
106 // check for file metadata...
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
107 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
108
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
109 /** The name of the (original) image file.
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
110 *
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
111 * @return
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
112 */
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
113 public String getName() {
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
114 if (!list.isEmpty()) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
115 return ((DocuFile) list.get(0)).getName();
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
116 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
117 return null;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
118 }
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
119
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
120 /** Returns the parent DocuDirectory.
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
121 * @return DocuDirectory
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
122 */
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
123 public DocuDirectory getParent() {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
124 return parent;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
125 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
126
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
127 /**
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
128 * Sets the parent.
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
129 * @param parent The parent to set
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
130 */
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
131 public void setParent(DocuDirectory parent) {
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
132 this.parent = parent;
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
133 }
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
134
91
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
135 /** Returns the meta-data for this fileset.
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
136 *
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
137 * @return HashMap
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
138 */
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
139 public HashMap getFileMeta() {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
140 return fileMeta;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
141 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
142
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
143 /**
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
144 * Sets the fileMeta.
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
145 * @param fileMeta The fileMeta to set
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
146 */
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
147 public void setFileMeta(HashMap fileMeta) {
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
148 this.fileMeta = fileMeta;
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
149 }
a398fc09ba71 New version 1.8b4.
robcast
parents: 86
diff changeset
150
86
997ba69afb81 New version 1.8b1.
robcast
parents:
diff changeset
151 }