blob: 4196a1b199ecb8dd435caa02edd8afe6212d69ad (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* $Id$ */
package org.apache.fop.render;
import java.util.Comparator;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import java.util.Map;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.xmlgraphics.image.loader.Image;
import org.apache.xmlgraphics.image.loader.ImageFlavor;
import org.apache.xmlgraphics.util.Service;
/**
* This class holds references to various image handlers used by the renderers. It also
* supports automatic discovery of additional handlers available through
* the class path.
*/
public abstract class AbstractImageHandlerRegistry {
/** the logger */
private static Log log = LogFactory.getLog(AbstractImageHandlerRegistry.class);
private static final Comparator HANDLER_COMPARATOR = new Comparator() {
public int compare(Object o1, Object o2) {
ImageHandlerBase h1 = (ImageHandlerBase)o1;
ImageHandlerBase h2 = (ImageHandlerBase)o2;
return h1.getPriority() - h2.getPriority();
}
};
/** Map containing image handlers for various MIME types */
private final Map/*<Class, ImageHandler>*/ handlers
= new java.util.HashMap/*<Class, ImageHandler>*/();
/** List containing the same handlers as above but ordered by priority */
private final List/*<ImageHandler>*/ handlerList
= new java.util.LinkedList/*<ImageHandler>*/();
/** Sorted Set of registered handlers */
private ImageFlavor[] supportedFlavors = new ImageFlavor[0];
private int handlerRegistrations;
private int lastSync;
/**
* Default constructor.
*/
public AbstractImageHandlerRegistry() {
discoverHandlers();
}
/**
* Add an ImageHandler. The handler itself is inspected to find out what it supports.
* @param classname the fully qualified class name
*/
public void addHandler(String classname) {
try {
ImageHandlerBase handlerInstance
= (ImageHandlerBase)Class.forName(classname).newInstance();
addHandler(handlerInstance);
} catch (ClassNotFoundException e) {
throw new IllegalArgumentException("Could not find "
+ classname);
} catch (InstantiationException e) {
throw new IllegalArgumentException("Could not instantiate "
+ classname);
} catch (IllegalAccessException e) {
throw new IllegalArgumentException("Could not access "
+ classname);
} catch (ClassCastException e) {
throw new IllegalArgumentException(classname
+ " is not an "
+ getHandlerClass().getName());
}
}
/**
* Add an image handler. The handler itself is inspected to find out what it supports.
* @param handler the ImageHandler instance
*/
public synchronized void addHandler(ImageHandlerBase handler) {
this.handlers.put(handler.getSupportedImageClass(), handler);
//Sorted insert
ListIterator iter = this.handlerList.listIterator();
while (iter.hasNext()) {
ImageHandlerBase h = (ImageHandlerBase)iter.next();
if (getHandlerComparator().compare(handler, h) < 0) {
iter.previous();
break;
}
}
iter.add(handler);
this.handlerRegistrations++;
}
/**
* Returns an ImageHandler which handles an specific image type given the MIME type
* of the image.
* @param img the Image to be handled
* @return the ImageHandler responsible for handling the image or null if none is available
*/
public ImageHandlerBase getHandler(Image img) {
return getHandler(img.getClass());
}
/**
* Returns an ImageHandler which handles an specific image type given the MIME type
* of the image.
* @param imageClass the Image subclass for which to get a handler
* @return the ImageHandler responsible for handling the image or null if none is available
*/
public synchronized ImageHandlerBase getHandler(Class imageClass) {
ImageHandlerBase handler = null;
Class cl = imageClass;
while (cl != null) {
handler = (ImageHandlerBase)handlers.get(cl);
if (handler != null) {
break;
}
cl = cl.getSuperclass();
}
return handler;
}
/**
* Returns the ordered array of supported image flavors.
* @return the array of image flavors
*/
public synchronized ImageFlavor[] getSupportedFlavors() {
if (this.lastSync != this.handlerRegistrations) {
//Extract all ImageFlavors into a single array
List flavors = new java.util.ArrayList();
Iterator iter = this.handlerList.iterator();
while (iter.hasNext()) {
ImageFlavor[] f = ((ImageHandlerBase)iter.next()).getSupportedImageFlavors();
for (int i = 0; i < f.length; i++) {
flavors.add(f[i]);
}
}
this.supportedFlavors = (ImageFlavor[])flavors.toArray(new ImageFlavor[flavors.size()]);
this.lastSync = this.handlerRegistrations;
}
return this.supportedFlavors;
}
/**
* Discovers ImageHandler implementations through the classpath and dynamically
* registers them.
*/
private void discoverHandlers() {
// add mappings from available services
Class imageHandlerClass = getHandlerClass();
Iterator providers = Service.providers(imageHandlerClass);
if (providers != null) {
while (providers.hasNext()) {
ImageHandlerBase handler = (ImageHandlerBase)providers.next();
try {
if (log.isDebugEnabled()) {
log.debug("Dynamically adding ImageHandler: "
+ handler.getClass().getName());
}
addHandler(handler);
} catch (IllegalArgumentException e) {
log.error("Error while adding ImageHandler", e);
}
}
}
}
/**
* Returns the ImageHandler comparator
*
* @return the ImageHandler comparator
*/
public Comparator getHandlerComparator() {
return HANDLER_COMPARATOR;
}
/**
* Returns the ImageHandler implementing class
*
* @return the ImageHandler implementing class
*/
public abstract Class getHandlerClass();
}
|
