source/mir/util/xml/XMLReaderTool.java

   1 /*
   2  * Copyright (C) 2001, 2002 The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   6  * Mir is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Mir is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Mir; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * In addition, as a special exception, The Mir-coders gives permission to link
  21  * the code of this program with  any library licensed under the Apache Software License,
  22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
  23  * (or with modified versions of the above that use the same license as the above),
  24  * and distribute linked combinations including the two.  You must obey the
  25  * GNU General Public License in all respects for all of the code used other than
  26  * the above mentioned libraries.  If you modify this file, you may extend this
  27  * exception to your version of the file, but you are not obligated to do so.
  28  * If you do not wish to do so, delete this exception statement from your version.
  29  */
  30 package mir.util.xml;
  31
  32 import java.util.HashMap;
  33 import java.util.Iterator;
  34 import java.util.Map;
  35
  36 public class XMLReaderTool {
  37   public static void checkValidIdentifier(String anIdentifier) throws XMLParserExc {
  38   }
  39
  40   public static String getStringAttributeWithDefault(java.util.Map anAttributes, String aKey, String aDefault) {
  41     if (anAttributes.containsKey(aKey))
  42       return (String) anAttributes.get(aKey);
  43     else
  44       return aDefault;
  45   }
  46
  47   public static void checkIntegerAttribute(java.util.Map anAttributes, String aKey) throws XMLParserExc {
  48     try {
  49       Integer.parseInt((String) anAttributes.get(aKey));
  50     }
  51     catch (Throwable t) {
  52       throw new XMLParserExc("attribute '"+aKey+"' is not an integer" );
  53     }
  54   }
  55
  56   public static int getIntegerAttributeWithDefault(java.util.Map anAttributes, String aKey, int aDefault) throws XMLParserExc  {
  57     if (anAttributes.containsKey(aKey)) {
  58       checkIntegerAttribute(anAttributes, aKey);
  59
  60       return Integer.parseInt((String) anAttributes.get(aKey));
  61     }
  62     else
  63       return aDefault;
  64   }
  65
  66   public static void checkAttributes(java.util.Map anAttributes, String[] aRequiredAttributes, String[] anOptionalAttributes)  throws XMLParserExc {
  67     checkAttributeSet(anAttributes.keySet(),
  68        new java.util.HashSet(java.util.Arrays.asList(aRequiredAttributes)),
  69        new java.util.HashSet(java.util.Arrays.asList(anOptionalAttributes)));
  70   }
  71
  72   public static void checkAttributeSet(java.util.Set aSet, java.util.Set aRequiredElements, java.util.Set anOptionalElements) throws XMLParserExc{
  73     java.util.Iterator i;
  74
  75     i = aSet.iterator();
  76     while (i.hasNext()) {
  77       Object item = i.next();
  78
  79       if (!(aRequiredElements.contains(item) || anOptionalElements.contains(item)))
  80         throw new XMLParserExc("unknown attribute '" + item + "'" );
  81     }
  82
  83     i = aRequiredElements.iterator();
  84     while (i.hasNext()) {
  85       Object item = i.next();
  86
  87       if (!(aSet.contains(item)))
  88         throw new XMLParserExc("missing required attribute '" + item + "'" );
  89     }
  90
  91   }
  92
  93   /**
  94    * Returns the namespace part of a qualified XML Tag name <br>
  95    * Example:<br>
  96    * <code>getPrefixFromQualifiedName("dc:creator");</code> <br>
  97    * will return <code>"dc"</code>
  98    */
  99
 100   public static String getPrefixFromQualifiedName(String aQualifiedName) {
 101     java.util.List parts = mir.util.StringRoutines.splitString(aQualifiedName, ":");
 102
 103     if (parts.size()<=1)
 104       return "";
 105     else
 106       return (String) parts.get(0);
 107   }
 108
 109   /**
 110    * Returns the localname part of a qualified XML Tag name <br>
 111    * Example:<br>
 112    * <code>getLocalNameFromQualifiedName("dc:creator");</code> <br>
 113    * will return <code>"creator"</code>
 114    */
 115   public static String getLocalNameFromQualifiedName(String aQualifiedName) {
 116     java.util.List parts = mir.util.StringRoutines.separateString(aQualifiedName, ":");
 117
 118     if (parts.size()<1)
 119       return null;
 120
 121     if (parts.size()==1)
 122       return (String) parts.get(0);
 123                 return (String) parts.get(1);
 124   }
 125
 126   /**
 127    * Creates an {@link XMLName} out of qualified name by splitting on the
 128    *    <code>:</code>.
 129    */
 130   public static XMLName getXMLNameForQualifiedName(String aQualifiedName) {
 131     return new XMLName(
 132         null,
 133         getPrefixFromQualifiedName(aQualifiedName),
 134         getLocalNameFromQualifiedName(aQualifiedName));
 135   }
 136
 137   /**
 138    * Turns a Map with {@link XMLName} keys into a map with {@link String} keys,
 139    *    by taking the <code>XMLName</code>'s local name
 140    */
 141   public static Map convertXMLAttributeMap(Map anXMLAttributeMap) {
 142     Map result = new HashMap();
 143
 144     Iterator i = anXMLAttributeMap.entrySet().iterator();
 145
 146     while (i.hasNext()) {
 147       Map.Entry entry = (Map.Entry) i.next();
 148
 149       result.put(
 150           ((XMLName) entry.getKey()).getLocalName(),
 151           entry.getValue());
 152     }
 153
 154     return result;
 155   }
 156
 157   /** formats an XML name as it would look in an XML file */
 158   public static String normalizeXMLName(mir.util.xml.XMLName aName) {
 159     String result = aName.getLocalName();
 160     if (aName.getPrefix().length() > 0)
 161       result = aName.getPrefix() + ":" + result;
 162
 163     return result;
 164   }
 165 }