--- projects/cms/source/util/uk/org/iscream/cms/util/XMLPacketMaker.java 2000/11/29 19:11:53 1.3 +++ projects/cms/source/util/uk/org/iscream/cms/util/XMLPacketMaker.java 2001/03/10 02:03:55 1.12 @@ -1,65 +1,76 @@ //---PACKAGE DECLARATION--- -package uk.ac.ukc.iscream.xml; +package uk.ac.ukc.iscream.util; //---IMPORTS--- import java.io.*; import java.util.ArrayList; import org.xml.sax.*; +import org.xml.sax.helpers.*; import javax.xml.parsers.SAXParserFactory; import javax.xml.parsers.ParserConfigurationException; import javax.xml.parsers.SAXParser; -import uk.ac.ukc.iscream.core.*; - /** * XMLPacketMaker - Creates an XMLPacket object. * * @author $Author: tdb $ - * @version $Id: XMLPacketMaker.java,v 1.3 2000/11/29 19:11:53 tdb Exp $ + * @version $Id: XMLPacketMaker.java,v 1.12 2001/03/10 02:03:55 tdb Exp $ */ -public class XMLPacketMaker extends HandlerBase { +public class XMLPacketMaker extends DefaultHandler { //---FINAL ATTRIBUTES--- /** * The current CVS revision of this class */ - public final String REVISION = "$Revision: 1.3 $"; - + public final String REVISION = "$Revision: 1.12 $"; + //---STATIC METHODS--- //---CONSTRUCTORS--- - // Constructor for accepting XML input. - public XMLPacketMaker (String xml, Logger logger) { - this.xml = xml; - this.logger = logger; + /** + * Constructor for accepting XML input. + * + * @param xml A String of XML to process. + */ + public XMLPacketMaker (String xml) { + _xml = xml; } + /** + * A static reference to the system saxParser factory + */ + private static SAXParserFactory factory = SAXParserFactory.newInstance(); + + //---PUBLIC METHODS--- - public XMLPacket createXMLPacket() { + /** + * Method to create an XML packet from the data this + * class was constructed with. + * + * @return an XMLPacket representing the XML String given + * @throws InvalidXMLException if the XML cannot be parsed + */ + public XMLPacket createXMLPacket() 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)); + InputSource inputSource = new InputSource(new StringReader(_xml)); SAXParser saxParser = factory.newSAXParser(); + saxParser.parse(inputSource, new XMLStringParser(packet)); - } catch (Exception e) { - logger.write(this.toString(), Logger.WARNING, "An invalid XML UDP packet has been detected: "+packet.printAll()); - //t.printStackTrace(); - 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; } @@ -67,10 +78,16 @@ 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 + * to format the toString() + * * @return the name of this class and its CVS revision */ public String toString() { - return this.getClass().getName() + "(" + REVISION.substring(11, REVISION.length() - 2) + ")"; + return FormatName.getName( + _name, + getClass().getName(), + REVISION); } //---PRIVATE METHODS--- @@ -79,8 +96,21 @@ public class XMLPacketMaker extends HandlerBase { //---ATTRIBUTES--- - String xml; - Logger logger; + /** + * Holds the xml + */ + String _xml; + + /** + * This is the friendly identifier of the + * component this class is running in. + * eg, a Filter may be called "filter1", + * If this class does not have an owning + * component, a name from the configuration + * can be placed here. This name could also + * be changed to null for utility classes. + */ + private String _name = null; //---STATIC ATTRIBUTES---