annotate servlet/src/digilib/io/DocuDirent.java @ 567:70c135bd17aa stream

Starting 'stream' branch
author robcast
date Tue, 21 Dec 2010 10:05:54 +0100
parents 686086d6e6d6
children 790cbfb58b52 a7e157d258e8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
1 /*
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
2 * DocuDirent.java -- Abstract directory entry in a DocuDirectory
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
3 *
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
4 * Digital Image Library servlet components
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
5 *
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
6 * Copyright (C) 2003 Robert Casties (robcast@mail.berlios.de)
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
7 *
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
8 * This program is free software; you can redistribute it and/or modify it
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
9 * under the terms of the GNU General Public License as published by the Free
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
10 * Software Foundation; either version 2 of the License, or (at your option)
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
11 * any later version.
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
12 *
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
13 * Please read license.txt for the full details. A copy of the GPL may be found
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
14 * at http://www.gnu.org/copyleft/lgpl.html
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
15 *
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
16 * You should have received a copy of the GNU General Public License along with
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
17 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
18 * Place, Suite 330, Boston, MA 02111-1307 USA
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
19 *
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
20 * Created on 15.09.2003 by casties
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
21 *
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
22 */
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
23 package digilib.io;
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
24
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
25 import java.io.File;
271
d3abaf38fb5f Servlet version 1.21b3
robcast
parents: 259
diff changeset
26 import java.util.Map;
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
27
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
28 import org.apache.log4j.Logger;
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
29
563
686086d6e6d6 more refactoring and rearranging
robcast
parents: 536
diff changeset
30 import digilib.io.FileOps.FileClass;
686086d6e6d6 more refactoring and rearranging
robcast
parents: 536
diff changeset
31
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
32 /**
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
33 * Abstract directory entry in a DocuDirectory.
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
34 *
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
35 * @author casties
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
36 *
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
37 */
531
9cedd170b581 * PDF generation works now even with subdirectories
robcast
parents:
diff changeset
38 public abstract class DocuDirent implements Comparable<Object> {
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
39
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
40 /** the file class of this file */
563
686086d6e6d6 more refactoring and rearranging
robcast
parents: 536
diff changeset
41 protected static FileClass fileClass = FileClass.NONE;
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
42 /** HashMap with metadata */
531
9cedd170b581 * PDF generation works now even with subdirectories
robcast
parents:
diff changeset
43 protected MetadataMap fileMeta = null;
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
44 /** Is the Metadata valid */
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
45 protected boolean metaChecked = false;
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
46 /** the parent directory */
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
47 protected Directory parent = null;
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
48
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
49 /**
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
50 * Checks metadata and does something with it.
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
51 *
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
52 */
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
53 public abstract void checkMeta();
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
54
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
55 /**
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
56 * gets the (default) File
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
57 *
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
58 * @return
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
59 */
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
60 public abstract File getFile();
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
61
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
62 /**
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
63 * Reads meta-data for this Fileset if there is any.
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
64 *
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
65 */
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
66 public void readMeta() {
195
f921735dc578 Servlet version 1.18b4
robcast
parents: 181
diff changeset
67 if ((fileMeta != null) || (getFile() == null)) {
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
68 // there is already metadata or there is no file
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
69 return;
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
70 }
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
71 // metadata is in the file {filename}.meta
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
72 String fn = getFile().getAbsolutePath();
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
73 File mf = new File(fn + ".meta");
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
74 if (mf.canRead()) {
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
75 XMLMetaLoader ml = new XMLMetaLoader();
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
76 try {
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
77 // read meta file
531
9cedd170b581 * PDF generation works now even with subdirectories
robcast
parents:
diff changeset
78 Map<String, MetadataMap> meta = ml.loadURL(mf.getAbsolutePath());
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
79 if (meta == null) {
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
80 return;
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
81 }
531
9cedd170b581 * PDF generation works now even with subdirectories
robcast
parents:
diff changeset
82 fileMeta = meta.get(getName());
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
83 } catch (Exception e) {
195
f921735dc578 Servlet version 1.18b4
robcast
parents: 181
diff changeset
84 Logger.getLogger(this.getClass()).warn("error reading file .meta", e);
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
85 }
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
86 }
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
87 }
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
88
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
89 /**
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
90 * The name of the file.
176
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
91 *
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 176
diff changeset
92 * If this is a Fileset, the method returns the name of the default file
176
67ff8c7fecb9 Servlet version 1.17b2
robcast
parents: 159
diff changeset
93 * (for image filesets the highest resolution file).
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
94 *
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
95 * @return
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
96 */
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
97 public String getName() {
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
98 File f = getFile();
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
99 return (f != null) ? f.getName() : null;
259
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
100 }
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
101
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
102 /**
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
103 * Returns the parent Directory.
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
104 *
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
105 * @return DocuDirectory
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
106 */
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
107 public Directory getParent() {
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
108 return parent;
259
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
109 }
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
110
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
111 /**
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
112 * Sets the parent Directory.
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
113 *
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
114 * @param parent
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
115 * The parent to set
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
116 */
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
117 public void setParent(Directory parent) {
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
118 this.parent = parent;
259
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
119 }
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
120
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
121 /**
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
122 * Returns the meta-data for this file(set).
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
123 *
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
124 * @return HashMap
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
125 */
531
9cedd170b581 * PDF generation works now even with subdirectories
robcast
parents:
diff changeset
126 public MetadataMap getFileMeta() {
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
127 return fileMeta;
259
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
128 }
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
129
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
130 /**
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
131 * Sets the meta-data for this file(set) .
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
132 *
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
133 * @param fileMeta
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
134 * The fileMeta to set
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
135 */
531
9cedd170b581 * PDF generation works now even with subdirectories
robcast
parents:
diff changeset
136 public void setFileMeta(MetadataMap fileMeta) {
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
137 this.fileMeta = fileMeta;
259
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
138 }
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
139
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
140 /**
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
141 * @return
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
142 */
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
143 public boolean isMetaChecked() {
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
144 return metaChecked;
259
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
145 }
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
146
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
147 /**
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
148 * @return
beed92ee6022 Servlet version 1.21b1
robcast
parents: 195
diff changeset
149 */
563
686086d6e6d6 more refactoring and rearranging
robcast
parents: 536
diff changeset
150 public static FileClass getFileClass() {
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
151 return fileClass;
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
152 }
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
153
271
d3abaf38fb5f Servlet version 1.21b3
robcast
parents: 259
diff changeset
154 /** Comparator using the file name.
475
1fc30116efc3 modified DocuDirent.compareTo instead of ImageFileset.compareTo
hertzhaft
parents: 371
diff changeset
155 * Compares to a String (for binarySearch)
1fc30116efc3 modified DocuDirent.compareTo instead of ImageFileset.compareTo
hertzhaft
parents: 371
diff changeset
156 * or to another DocuDirent (for sort)
271
d3abaf38fb5f Servlet version 1.21b3
robcast
parents: 259
diff changeset
157 *
d3abaf38fb5f Servlet version 1.21b3
robcast
parents: 259
diff changeset
158 * @see java.lang.Comparable#compareTo(java.lang.Object)
d3abaf38fb5f Servlet version 1.21b3
robcast
parents: 259
diff changeset
159 */
d3abaf38fb5f Servlet version 1.21b3
robcast
parents: 259
diff changeset
160 public int compareTo(Object arg0) {
531
9cedd170b581 * PDF generation works now even with subdirectories
robcast
parents:
diff changeset
161 if (arg0 instanceof DocuDirent) {
9cedd170b581 * PDF generation works now even with subdirectories
robcast
parents:
diff changeset
162 return getName().compareTo(((DocuDirent) arg0).getName());
9cedd170b581 * PDF generation works now even with subdirectories
robcast
parents:
diff changeset
163 } else {
9cedd170b581 * PDF generation works now even with subdirectories
robcast
parents:
diff changeset
164 return getName().compareTo((String) arg0);
9cedd170b581 * PDF generation works now even with subdirectories
robcast
parents:
diff changeset
165 }
271
d3abaf38fb5f Servlet version 1.21b3
robcast
parents: 259
diff changeset
166 }
475
1fc30116efc3 modified DocuDirent.compareTo instead of ImageFileset.compareTo
hertzhaft
parents: 371
diff changeset
167
271
d3abaf38fb5f Servlet version 1.21b3
robcast
parents: 259
diff changeset
168
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
169 }