--- projects/cms/source/util/uk/org/iscream/cms/util/XMLPacketMaker.java 2001/01/18 01:55:57 1.8 +++ projects/cms/source/util/uk/org/iscream/cms/util/XMLPacketMaker.java 2002/05/18 18:16:04 1.17 @@ -1,60 +1,80 @@ +/* + * i-scream central monitoring system + * Copyright (C) 2000-2002 i-scream + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + */ + //---PACKAGE DECLARATION--- -package uk.ac.ukc.iscream.util; +package uk.org.iscream.cms.server.util; //---IMPORTS--- import java.io.*; -import java.util.ArrayList; - import org.xml.sax.*; -import javax.xml.parsers.SAXParserFactory; -import javax.xml.parsers.ParserConfigurationException; -import javax.xml.parsers.SAXParser; +import javax.xml.parsers.*; /** * XMLPacketMaker - Creates an XMLPacket object. * * @author $Author: tdb $ - * @version $Id: XMLPacketMaker.java,v 1.8 2001/01/18 01:55:57 tdb Exp $ + * @version $Id: XMLPacketMaker.java,v 1.17 2002/05/18 18:16:04 tdb Exp $ */ -public class XMLPacketMaker extends HandlerBase { +public class XMLPacketMaker { //---FINAL ATTRIBUTES--- /** * The current CVS revision of this class */ - public final String REVISION = "$Revision: 1.8 $"; - + public final String REVISION = "$Revision: 1.17 $"; + + /** + * A reference to the system saxParser factory + */ + private final SAXParserFactory _factory = SAXParserFactory.newInstance(); + //---STATIC METHODS--- //---CONSTRUCTORS--- - // Constructor for accepting XML input. - public XMLPacketMaker (String xml) { - _xml = xml; - } - //---PUBLIC METHODS--- - public XMLPacket createXMLPacket() { + /** + * Method to create an XML packet from the data this + * class was constructed with. + * + * @param xml the XML String to parse + * @return an XMLPacket representing the XML String given + * @throws InvalidXMLException if the XML cannot be parsed + */ + public XMLPacket createXMLPacket(String xml) throws InvalidXMLException { // Create the XMLPacket to store values in. XMLPacket packet = new XMLPacket(); - - // Use the default (non-validating) parser - SAXParserFactory factory = SAXParserFactory.newInstance(); + try { - // Parse the input - InputSource inputSource = new InputSource(new StringReader(_xml)); - SAXParser saxParser = factory.newSAXParser(); - saxParser.parse(inputSource, new XMLStringParser(packet)); - + InputSource inputSource = new InputSource(new StringReader(xml)); + _factory.newSAXParser().parse(inputSource, new XMLStringParser(packet)); } catch (Exception e) { - return null; + // couldn't parse the XML for some reason + throw new InvalidXMLException("Could not parse the XML: "+xml); } + // parsed successfully, return the packet return packet; } @@ -62,7 +82,7 @@ public class XMLPacketMaker extends HandlerBase { * Overrides the {@link java.lang.Object#toString() Object.toString()} * method to provide clean logging (every class should have this). * - * This uses the uk.ac.ukc.iscream.util.NameFormat class + * This uses the uk.org.iscream.cms.server.util.NameFormat class * to format the toString() * * @return the name of this class and its CVS revision @@ -79,11 +99,6 @@ public class XMLPacketMaker extends HandlerBase { //---ACCESSOR/MUTATOR METHODS--- //---ATTRIBUTES--- - - /** - * Holds the xml - */ - String _xml; /** * This is the friendly identifier of the