annotate servlet/src/digilib/io/XMLListLoader.java @ 140:c878ea574c29

Servlet Version 1.12b2 - fixed small error in XML config parser - improved high quality scaling with minSubsample parameter
author robcast
date Fri, 15 Aug 2003 23:52:20 +0200
parents d18b0ff52b07
children 67ff8c7fecb9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
1 /* XMLListLoader -- Load an XML list into a Hashtable
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
2
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
3 Digital Image Library servlet components
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
4
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
5 Copyright (C) 2001, 2002 Robert Casties (robcast@mail.berlios.de)
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
6
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
7 This program is free software; you can redistribute it and/or modify it
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
9 Free Software Foundation; either version 2 of the License, or (at your
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
10 option) any later version.
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
11
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
12 Please read license.txt for the full details. A copy of the GPL
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
13 may be found at http://www.gnu.org/copyleft/lgpl.html
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
14
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
16 along with this program; if not, write to the Free Software
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
18
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
19 */
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
20
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
21 package digilib.io;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
22
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
23 // JAXP packages
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
24 import java.io.IOException;
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
25 import java.util.HashMap;
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
26 import java.util.LinkedList;
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
27
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
28 import javax.xml.parsers.ParserConfigurationException;
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
29 import javax.xml.parsers.SAXParser;
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
30 import javax.xml.parsers.SAXParserFactory;
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
31
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
32 import org.xml.sax.Attributes;
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
33 import org.xml.sax.SAXException;
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
34 import org.xml.sax.SAXParseException;
140
c878ea574c29 Servlet Version 1.12b2
robcast
parents: 138
diff changeset
35 import org.xml.sax.helpers.DefaultHandler;
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
36
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
37 public class XMLListLoader {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
38
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
39 private String listTag = "list";
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
40 private String entryTag = "entry";
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
41 private String keyAtt = "key";
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
42 private String valueAtt = "value";
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
43
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
44 public XMLListLoader() {
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
45 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
46
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
47 public XMLListLoader(
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
48 String list_tag,
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
49 String entry_tag,
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
50 String key_att,
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
51 String value_att) {
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
52 //System.out.println("xmlListLoader("+list_tag+","+entry_tag+","+key_att+","+value_att+")");
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
53 listTag = list_tag;
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
54 entryTag = entry_tag;
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
55 keyAtt = key_att;
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
56 valueAtt = value_att;
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
57 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
58
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
59 /**
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
60 * inner class XMLListParser to be called by the parser
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
61 */
140
c878ea574c29 Servlet Version 1.12b2
robcast
parents: 138
diff changeset
62 private class XMLListParser extends DefaultHandler {
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
63
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
64 private HashMap listData;
138
d18b0ff52b07 *** empty log message ***
robcast
parents: 128
diff changeset
65 private LinkedList tagSpace;
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
66
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
67 public HashMap getData() {
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
68 return listData;
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
69 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
70
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
71 // Parser calls this once at the beginning of a document
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
72 public void startDocument() throws SAXException {
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
73 listData = new HashMap();
138
d18b0ff52b07 *** empty log message ***
robcast
parents: 128
diff changeset
74 tagSpace = new LinkedList();
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
75 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
76
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
77 // Parser calls this for each element in a document
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
78 public void startElement(
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
79 String namespaceURI,
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
80 String localName,
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
81 String qName,
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
82 Attributes atts)
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
83 throws SAXException {
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
84 //System.out.println("<"+qName);
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
85 // open a new namespace
138
d18b0ff52b07 *** empty log message ***
robcast
parents: 128
diff changeset
86 tagSpace.addLast(qName);
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
87
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
88 // ist it an entry tag?
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
89 if (qName.equals(entryTag)) {
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
90 // is it inside a list tag?
138
d18b0ff52b07 *** empty log message ***
robcast
parents: 128
diff changeset
91 if ((listTag.length() > 0) && (!tagSpace.contains(listTag))) {
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
92 System.out.println(
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
93 "BOO: Entry "
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
94 + entryTag
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
95 + " not inside list "
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
96 + listTag);
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
97 throw new SAXParseException(
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
98 "Entry " + entryTag + " not inside list " + listTag,
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
99 null);
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
100 }
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
101 // get the attributes
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
102 String key = atts.getValue(keyAtt);
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
103 String val = atts.getValue(valueAtt);
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
104 if ((key == null) || (val == null)) {
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
105 System.out.println(
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
106 "BOO: Entry "
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
107 + entryTag
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
108 + " does not have Attributes "
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
109 + keyAtt
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
110 + ", "
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
111 + valueAtt);
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
112 throw new SAXParseException(
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
113 "Entry "
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
114 + entryTag
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
115 + " does not have Attributes "
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
116 + keyAtt
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
117 + ", "
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
118 + valueAtt,
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
119 null);
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
120 }
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
121 // add the values
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
122 //System.out.println("DATA: "+key+" = "+val);
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
123 listData.put(key, val);
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
124 }
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
125 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
126
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
127 public void endElement(
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
128 String namespaceURI,
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
129 String localName,
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
130 String qName)
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
131 throws SAXException {
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
132 // exit the namespace
138
d18b0ff52b07 *** empty log message ***
robcast
parents: 128
diff changeset
133 tagSpace.removeLast();
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
134 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
135
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
136 }
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
137
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
138 /**
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
139 * load and parse a file (as URL)
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
140 * returns HashMap with list data
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
141 */
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
142 public HashMap loadURL(String path) throws SAXException, IOException {
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
143 //System.out.println("loadurl ("+path+")");
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
144 // Create a JAXP SAXParserFactory and configure it
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
145 SAXParserFactory spf = SAXParserFactory.newInstance();
138
d18b0ff52b07 *** empty log message ***
robcast
parents: 128
diff changeset
146 spf.setNamespaceAware(true);
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
147
138
d18b0ff52b07 *** empty log message ***
robcast
parents: 128
diff changeset
148 SAXParser parser = null;
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
149 try {
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
150 // Create a JAXP SAXParser
138
d18b0ff52b07 *** empty log message ***
robcast
parents: 128
diff changeset
151 parser = spf.newSAXParser();
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
152
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
153 } catch (ParserConfigurationException e) {
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
154 throw new SAXException(e);
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
155 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
156
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
157 // create a list parser (keeps the data!)
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
158 XMLListParser listParser = new XMLListParser();
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
159
138
d18b0ff52b07 *** empty log message ***
robcast
parents: 128
diff changeset
160 // Tell the SAXParser to parse the XML document
d18b0ff52b07 *** empty log message ***
robcast
parents: 128
diff changeset
161 parser.parse(path, listParser);
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
162
88
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
163 return listParser.getData();
398d39ee1014 New version 1.8b4.
robcast
parents: 56
diff changeset
164 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
165
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
166 }