annotate servlet/src/digilib/io/ImageFile.java @ 596:2b58d2783ef0 stream

small cleanup
author robcast
date Sun, 09 Jan 2011 21:51:07 +0100
parents 69bc69381ac4
children f210731dc6cc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
1 /* ImageFile.java -- digilib image file class.
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
2
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
3 Digital Image Library servlet components
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
4
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
5 Copyright (C) 2003 Robert Casties (robcast@mail.berlios.de)
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
6
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
7 This program is free software; you can redistribute it and/or modify it
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
9 Free Software Foundation; either version 2 of the License, or (at your
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
10 option) any later version.
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
11
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
12 Please read license.txt for the full details. A copy of the GPL
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
13 may be found at http://www.gnu.org/copyleft/lgpl.html
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
14
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
16 along with this program; if not, write to the Free Software
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
18
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
19 * Created on 25.02.2003
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
20 */
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
21
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
22 package digilib.io;
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
23
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
24 import java.io.File;
585
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
25 import java.io.IOException;
590
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
26 import java.io.RandomAccessFile;
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
27
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
28 import javax.imageio.stream.FileImageInputStream;
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
29 import javax.imageio.stream.ImageInputStream;
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
30
585
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
31 import digilib.servlet.DigilibConfiguration;
596
2b58d2783ef0 small cleanup
robcast
parents: 590
diff changeset
32 import digilib.util.ImageSize;
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
33
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
34 /**
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
35 * @author casties
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
36 */
568
34701340922e more starting stream support
robcast
parents: 566
diff changeset
37 public class ImageFile extends ImageInput {
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
38
583
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
39 // file
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
40 private File file = null;
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
41 // file name
583
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
42 private String name = null;
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
43 // parent directory
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
44 private Directory dir = null;
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
45
583
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
46 /** Constructor with File.
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
47 *
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
48 * @param f
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
49 * @param parent
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
50 * @param dir
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
51 */
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
52 public ImageFile(File f, ImageSet parent, Directory dir) {
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
53 this.file = f;
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
54 this.name = f.getName();
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
55 this.parent = parent;
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
56 this.dir = dir;
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
57 }
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
58
583
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
59 /** Constructor with filename (without path).
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
60 * @param fn
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
61 * @param parent
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
62 * @param dir
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
63 */
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
64 public ImageFile(String fn, ImageSet parent, Directory dir) {
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
65 this.name = fn;
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
66 this.dir = dir;
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
67 this.file = new File(this.dir.getDir(), fn);
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
68 this.parent = parent;
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
69 }
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
70
585
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
71
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
72 /** Checks the image and sets size and type.
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
73 *
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
74 */
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
75 public void check() {
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
76 if (pixelSize == null) {
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
77 try {
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
78 // use the configured toolkit to identify the image
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
79 DigilibConfiguration.identifyDocuImage(this);
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
80 } catch (IOException e) {
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
81 // nothing much to do...
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
82 }
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
83 }
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
84 }
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
85
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
86 /* (non-Javadoc)
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
87 * @see digilib.io.ImageInput#getSize()
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
88 */
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
89 @Override
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
90 public ImageSize getSize() {
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
91 check();
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
92 return pixelSize;
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
93 }
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
94
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
95 /* (non-Javadoc)
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
96 * @see digilib.io.ImageInput#getMimetype()
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
97 */
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
98 @Override
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
99 public String getMimetype() {
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
100 check();
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
101 return mimetype;
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
102 }
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
103
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
104 /* (non-Javadoc)
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
105 * @see digilib.io.ImageInput#getAspect()
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
106 */
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
107 @Override
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
108 public float getAspect() {
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
109 check();
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
110 return (pixelSize != null) ? pixelSize.getAspect() : 0f;
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
111 }
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
112
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
113 /** Returns the file name (without path).
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
114 *
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
115 * @return
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
116 */
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
117 public String getName() {
583
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
118 return name;
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
119 }
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
120
590
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
121
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
122 /* (non-Javadoc)
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
123 * @see digilib.io.ImageInput#hasImageInputStream()
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
124 */
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
125 @Override
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
126 public boolean hasImageInputStream() {
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
127 return true;
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
128 }
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
129
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
130 /* (non-Javadoc)
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
131 * @see digilib.io.ImageInput#getImageInputStream()
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
132 */
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
133 @Override
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
134 public ImageInputStream getImageInputStream() {
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
135 try {
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
136 RandomAccessFile rf = new RandomAccessFile(file, "r");
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
137 return new FileImageInputStream(rf);
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
138 } catch (IOException e) {
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
139 // what now?
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
140 }
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
141 return null;
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
142 }
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
143
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
144 /* (non-Javadoc)
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
145 * @see digilib.io.ImageInput#hasFile()
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
146 */
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
147 @Override
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
148 public boolean hasFile() {
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
149 return true;
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
150 }
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
151
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
152 /* (non-Javadoc)
69bc69381ac4 more work on stream input and more cleanup
robcast
parents: 588
diff changeset
153 * @see digilib.io.ImageInput#getFile()
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
154 */
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
155 public File getFile() {
583
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
156 return file;
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
157 }
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
158
566
50f291d808b1 starting stream support
robcast
parents: 463
diff changeset
159 /* (non-Javadoc)
568
34701340922e more starting stream support
robcast
parents: 566
diff changeset
160 * @see digilib.io.ImageInput#setSize(digilib.image.ImageSize)
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
161 */
568
34701340922e more starting stream support
robcast
parents: 566
diff changeset
162 public void setSize(ImageSize imageSize) {
34701340922e more starting stream support
robcast
parents: 566
diff changeset
163 this.pixelSize = imageSize;
34701340922e more starting stream support
robcast
parents: 566
diff changeset
164 // pass on to parent
34701340922e more starting stream support
robcast
parents: 566
diff changeset
165 if (this.parent != null) {
34701340922e more starting stream support
robcast
parents: 566
diff changeset
166 this.parent.setAspect(imageSize);
34701340922e more starting stream support
robcast
parents: 566
diff changeset
167 }
566
50f291d808b1 starting stream support
robcast
parents: 463
diff changeset
168 }
50f291d808b1 starting stream support
robcast
parents: 463
diff changeset
169
576
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
170 /* (non-Javadoc)
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
171 * @see java.lang.Object#toString()
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
172 */
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
173 @Override
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
174 public String toString() {
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
175 // try to use File.toString
583
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
176 if (file != null) {
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
177 return file.toString();
576
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
178 }
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
179 return super.toString();
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
180 }
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
181
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
182
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
183 }