split the XML parser from the producer-config reader and improved XML parser error...
[mir.git] / source / mir / util / XMLReaderTool.java
1 package mir.util;
2
3 /*
4  * Copyright (C) 2001, 2002  The Mir-coders group
5  *
6  * This file is part of Mir.
7  *
8  * Mir is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * Mir is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with Mir; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  *
22  * In addition, as a special exception, The Mir-coders gives permission to link
23  * the code of this program with the com.oreilly.servlet library, any library
24  * licensed under the Apache Software License, The Sun (tm) Java Advanced
25  * Imaging library (JAI), The Sun JIMI library (or with modified versions of
26  * the above that use the same license as the above), and distribute linked
27  * combinations including the two.  You must obey the GNU General Public
28  * License in all respects for all of the code used other than the above
29  * mentioned libraries.  If you modify this file, you may extend this exception
30  * to your version of the file, but you are not obligated to do so.  If you do
31  * not wish to do so, delete this exception statement from your version.
32  */
33
34 import java.util.Arrays;
35 import java.util.HashSet;
36 import java.util.Iterator;
37 import java.util.Map;
38 import java.util.Set;
39
40 public class XMLReaderTool {
41
42   public static void checkValidIdentifier(String anIdentifier) throws XMLReader.XMLReaderExc {
43   }
44
45   public static String getStringAttributeWithDefault(Map anAttributes, String aKey, String aDefault) {
46     if (anAttributes.containsKey(aKey))
47       return (String) anAttributes.get(aKey);
48     else
49       return aDefault;
50   }
51
52   public static void checkIntegerAttribute(Map anAttributes, String aKey) throws XMLReader.XMLReaderExc {
53     try {
54       Integer.parseInt((String) anAttributes.get(aKey));
55     }
56     catch (Throwable t) {
57       throw new XMLReader.XMLReaderExc("attribute '"+aKey+"' is not an integer" );
58     }
59   }
60
61   public static int getIntegerAttributeWithDefault(Map anAttributes, String aKey, int aDefault) throws XMLReader.XMLReaderExc  {
62     String value;
63
64     if (anAttributes.containsKey(aKey)) {
65       checkIntegerAttribute(anAttributes, aKey);
66       return Integer.parseInt((String) anAttributes.get(aKey));
67     }
68     else
69       return aDefault;
70   }
71
72   public static void checkAttributes(Map anAttributes, String[] aRequiredAttributes, String[] anOptionalAttributes)  throws XMLReader.XMLReaderExc {
73     checkAttributeSet(anAttributes.keySet(),
74        new HashSet(Arrays.asList(aRequiredAttributes)),
75        new HashSet(Arrays.asList(anOptionalAttributes)));
76   }
77
78   public static void checkAttributeSet(Set aSet, Set aRequiredElements, Set anOptionalElements) throws XMLReader.XMLReaderExc{
79     Iterator i;
80
81     i = aSet.iterator();
82     while (i.hasNext()) {
83       Object item = i.next();
84
85       if (!(aRequiredElements.contains(item) || anOptionalElements.contains(item)))
86         throw new XMLReader.XMLReaderExc("unknown attribute '" + item + "'" );
87     }
88
89     i = aRequiredElements.iterator();
90     while (i.hasNext()) {
91       Object item = i.next();
92
93       if (!(aSet.contains(item)))
94         throw new XMLReader.XMLReaderExc("missing required attribute '" + item + "'" );
95     }
96
97   }
98 }