annotate servlet/src/digilib/io/ImageFile.java @ 585:95417c4615b8 stream

more cleanup for ImageFileSet
author robcast
date Wed, 05 Jan 2011 14:41:28 +0100
parents 7357ad8f9f42
children aee436f0549d
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;
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
26
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
27 import digilib.image.ImageSize;
585
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
28 import digilib.servlet.DigilibConfiguration;
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
29
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
30 /**
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
31 * @author casties
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
32 */
568
34701340922e more starting stream support
robcast
parents: 566
diff changeset
33 public class ImageFile extends ImageInput {
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
34
583
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
35 // file
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
36 private File file = null;
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
37 // file name
583
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
38 private String name = null;
574
790cbfb58b52 ripping apart ImageFileSet
robcast
parents: 568
diff changeset
39 // parent ImageSet
790cbfb58b52 ripping apart ImageFileSet
robcast
parents: 568
diff changeset
40 private ImageSet parent = null;
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
41 // parent directory
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
42 private Directory dir = null;
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
43
583
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
44 /** Constructor with File.
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
45 *
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
46 * @param f
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
47 * @param parent
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
48 * @param dir
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
49 */
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
50 public ImageFile(File f, ImageSet parent, Directory dir) {
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
51 this.file = f;
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
52 this.name = f.getName();
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
53 this.parent = parent;
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
54 this.dir = dir;
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
55 }
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
56
583
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
57 /** Constructor with filename (without path).
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
58 * @param fn
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
59 * @param parent
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
60 * @param dir
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
61 */
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
62 public ImageFile(String fn, ImageSet parent, Directory dir) {
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
63 this.name = fn;
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
64 this.dir = dir;
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
65 this.file = new File(this.dir.getDir(), fn);
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
66 this.parent = parent;
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
67 }
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
68
585
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
69
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
70 /** Checks the image and sets size and type.
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
71 *
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
72 */
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
73 public void check() {
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
74 if (pixelSize == null) {
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
75 try {
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
76 // use the configured toolkit to identify the image
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
77 DigilibConfiguration.identifyDocuImage(this);
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
78 } catch (IOException e) {
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
79 // nothing much to do...
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
80 }
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
81 }
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 /* (non-Javadoc)
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
85 * @see digilib.io.ImageInput#getSize()
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
86 */
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
87 @Override
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
88 public ImageSize getSize() {
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
89 check();
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
90 return pixelSize;
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
91 }
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
92
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
93 /* (non-Javadoc)
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
94 * @see digilib.io.ImageInput#getMimetype()
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
95 */
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
96 @Override
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
97 public String getMimetype() {
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
98 check();
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
99 return mimetype;
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
100 }
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
101
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
102 /* (non-Javadoc)
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
103 * @see digilib.io.ImageInput#getAspect()
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
104 */
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
105 @Override
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
106 public float getAspect() {
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
107 check();
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
108 return (pixelSize != null) ? pixelSize.getAspect() : 0f;
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
109 }
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
110
95417c4615b8 more cleanup for ImageFileSet
robcast
parents: 583
diff changeset
111 /** Returns the file name (without path).
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
112 *
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
113 * @return
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
114 */
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
115 public String getName() {
583
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
116 return name;
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
117 }
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
118
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
119 /**
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
120 * @return File
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
121 */
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
122 public File getFile() {
583
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
123 return file;
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
124 }
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
125
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
126 /**
574
790cbfb58b52 ripping apart ImageFileSet
robcast
parents: 568
diff changeset
127 * @return ImageSet
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
128 */
574
790cbfb58b52 ripping apart ImageFileSet
robcast
parents: 568
diff changeset
129 public ImageSet getParent() {
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
130 return parent;
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
131 }
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
132
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
133 /**
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
134 * Sets the parent.
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
135 * @param parent The parent to set
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
136 */
574
790cbfb58b52 ripping apart ImageFileSet
robcast
parents: 568
diff changeset
137 public void setParent(ImageSet parent) {
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
138 this.parent = parent;
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
139 }
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
140
566
50f291d808b1 starting stream support
robcast
parents: 463
diff changeset
141 /* (non-Javadoc)
568
34701340922e more starting stream support
robcast
parents: 566
diff changeset
142 * @see digilib.io.ImageInput#setSize(digilib.image.ImageSize)
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
143 */
568
34701340922e more starting stream support
robcast
parents: 566
diff changeset
144 public void setSize(ImageSize imageSize) {
34701340922e more starting stream support
robcast
parents: 566
diff changeset
145 this.pixelSize = imageSize;
34701340922e more starting stream support
robcast
parents: 566
diff changeset
146 // pass on to parent
34701340922e more starting stream support
robcast
parents: 566
diff changeset
147 if (this.parent != null) {
34701340922e more starting stream support
robcast
parents: 566
diff changeset
148 this.parent.setAspect(imageSize);
34701340922e more starting stream support
robcast
parents: 566
diff changeset
149 }
566
50f291d808b1 starting stream support
robcast
parents: 463
diff changeset
150 }
50f291d808b1 starting stream support
robcast
parents: 463
diff changeset
151
576
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
152 /* (non-Javadoc)
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
153 * @see java.lang.Object#toString()
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
154 */
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
155 @Override
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
156 public String toString() {
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
157 // try to use File.toString
583
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
158 if (file != null) {
7357ad8f9f42 more ripping apart ImageFileSet
robcast
parents: 576
diff changeset
159 return file.toString();
576
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
160 }
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
161 return super.toString();
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
162 }
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
163
dad720e9b12b try: DocuDirent as interface, ImageFile inherits from ImageInput and implements DocuDirent
robcast
parents: 574
diff changeset
164
159
e743b853efca servlet version 1.16a4
robcast
parents:
diff changeset
165 }