Thanks Emmanuel, I've attached a modifed XMLPropertiesConfiguration.java. I've just done the SAX todo. If it's up to scratch, I'd like to implement the includes todo as well, if that's ok, though I'll ask your opinion of my idea before doing anything.
cheers, Alistair -- Alistair Young Senior Software Engineer [EMAIL PROTECTED] M�r Ostaig Isle of Skye Scotland > Hi Alistair, thank you for offering your help, feel free to submit your > implementation on this list. We will review it and integrate it in the > code if it works fine. Alternatively you can open an entry in Bugzilla > and attach your changes there. > > Emmanuel Bourg > > > Alistair Young wrote: >> Hi folks, >> I wonder if I could possibly submit a todo implementation for >> org.apache.commons.configuration.XMLPropertiesConfiguration. >> >> I was looking at the XML part as we're thinking of using >> commons-configuration in the Bodington VLE and saw a todo for converting >> XMLPropertiesConfiguration.load() from Digester to SAX. >> >> I'd like to do the "include" todo as well if that's ok as it's a feature >> we could use for the VLE. >> >> Should I send the modified source to the list? >> >> cheers, >> >> Alistair >> >> > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] > >
/* * Copyright 2004 The Apache Software Foundation. * * Licensed 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. */ package org.apache.commons.configuration; import java.io.*; import java.net.URL; import java.util.Iterator; import java.util.List; import org.apache.commons.lang.StringEscapeUtils; import org.apache.commons.lang.StringUtils; import org.xml.sax.*; import org.xml.sax.helpers.DefaultHandler; import javax.xml.parsers.SAXParserFactory; import javax.xml.parsers.SAXParser; /** * This configuration implements the XML properties format introduced in Java * 5.0, see http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html. * An XML properties file looks like this: * * <pre> * <?xml version="1.0"?> * <!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd";> * <properties> * <comment>Description of the property list</comment> * <entry key="key1">value1</entry> * <entry key="key2">value2</entry> * <entry key="key3">value3</entry> * </properties> * </pre> * * The Java 5.0 runtime is not required to use this class. The default encoding * for this configuration format is UTF-8. Note that unlike * <code>PropertiesConfiguration</code>, <code>XMLPropertiesConfiguration</code> * does not support includes. * * @since 1.1 * * @author Emmanuel Bourg * @version $Revision: 155408 $, $Date: 2005-02-26 13:56:39 +0100 (Sa, 26 Feb 2005) $ */ public class XMLPropertiesConfiguration extends PropertiesConfiguration { /** * The default encoding (UTF-8 as specified by http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html) */ private static final String DEFAULT_ENCODING = "UTF-8"; // initialization block to set the encoding before loading the file in the constructors { setEncoding(DEFAULT_ENCODING); } /** * Creates an empty XMLPropertyConfiguration object which can be * used to synthesize a new Properties file by adding values and * then saving(). An object constructed by this C'tor can not be * tickled into loading included files because it cannot supply a * base for relative includes. */ public XMLPropertiesConfiguration() { super(); } /** * Creates and loads the xml properties from the specified file. * The specified file can contain "include" properties which then * are loaded and merged into the properties. * * @param fileName The name of the properties file to load. * @throws ConfigurationException Error while loading the properties file */ public XMLPropertiesConfiguration(String fileName) throws ConfigurationException { super(fileName); } /** * Creates and loads the xml properties from the specified file. * The specified file can contain "include" properties which then * are loaded and merged into the properties. * * @param file The properties file to load. * @throws ConfigurationException Error while loading the properties file */ public XMLPropertiesConfiguration(File file) throws ConfigurationException { super(file); } /** * Creates and loads the xml properties from the specified URL. * The specified file can contain "include" properties which then * are loaded and merged into the properties. * * @param url The location of the properties file to load. * @throws ConfigurationException Error while loading the properties file */ public XMLPropertiesConfiguration(URL url) throws ConfigurationException { super(url); } public void load(Reader in) throws ConfigurationException { SAXParserFactory factory = SAXParserFactory.newInstance(); factory.setNamespaceAware(false); factory.setValidating(true); try { SAXParser parser = factory.newSAXParser(); XMLReader xmlReader = parser.getXMLReader(); xmlReader.setEntityResolver(new EntityResolver(){ public InputSource resolveEntity(String publicId, String systemId) { return new InputSource(getClass().getClassLoader().getResourceAsStream("properties.dtd")); } }); xmlReader.setContentHandler(new Java5XMLPropsHandler(this)); xmlReader.parse(new InputSource(in)); } catch(Exception e) { throw new ConfigurationException("Unable to parse the configuration file", e); } // todo: support included properties ? } public void save(Writer out) throws ConfigurationException { PrintWriter writer = new PrintWriter(out); String encoding = getEncoding() != null ? getEncoding() : DEFAULT_ENCODING; writer.println("<?xml version=\"1.0\" encoding=\"" + encoding + "\"?>"); writer.println("<!DOCTYPE properties SYSTEM \"http://java.sun.com/dtd/properties.dtd\";>"); writer.println("<properties>"); if (getHeader() != null) { writer.println(" <comment>" + StringEscapeUtils.escapeXml(getHeader()) + "</comment>"); } Iterator keys = getKeys(); while (keys.hasNext()) { String key = (String) keys.next(); Object value = getProperty(key); if (value instanceof List) { writeProperty(writer, key, (List) value); } else { writeProperty(writer, key, value); } } writer.println("</properties>"); writer.flush(); } /** * Write a property. */ private void writeProperty(PrintWriter out, String key, Object value) { // escape the key String k = StringEscapeUtils.escapeXml(key); if (value != null) { // escape the value String v = StringEscapeUtils.escapeXml(String.valueOf(value)); v = StringUtils.replace(v, String.valueOf(getDelimiter()), "\\" + getDelimiter()); out.println(" <entry key=\"" + k + "\">" + v + "</entry>"); } else { out.println(" <entry key=\"" + k + "\"/>"); } } /** * Write a list property. */ private void writeProperty(PrintWriter out, String key, List values) { for (int i = 0; i < values.size(); i++) { writeProperty(out, key, values.get(i)); } } class Java5XMLPropsHandler extends DefaultHandler { Locator docLocator = null; String key,value = ""; boolean inCommentElement, inEntryElement = false; XMLPropertiesConfiguration propsClass = null; public Java5XMLPropsHandler(XMLPropertiesConfiguration clazz) { propsClass = clazz; } public void setDocumentLocator(Locator locator) { docLocator = locator; } public void startElement(String uri, String localName, String qName, Attributes attrs) { if (qName.equals("comment")) { inCommentElement = true; } if (qName.equals("entry")) { key = attrs.getValue("key"); inEntryElement = true; } } public void endElement(String uri, String localName, String qName) { if (inCommentElement) { // We've just finished a <comment> element so set the header propsClass.setHeader(value); inCommentElement = false; } if (inEntryElement) { // We've just finished an <entry> element, so add the key/value pair propsClass.addProperty(key, value); inEntryElement = false; } // Clear the element value buffer value = ""; } public void characters(char[] chars, int start, int length) { /* We're currently processing an element. All character data from now until * the next endElement() call will be the data for this element. */ value += new String(chars, start, length); } } }
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
