cms/util/XMLPacketMaker.java

//---PACKAGE DECLARATION---
package uk.ac.ukc.iscream.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;

/**
 * XMLPacketMaker - Creates an XMLPacket object.
 *
 * @author  $Author: tdb1 $
 * @version $Id: XMLPacketMaker.java,v 1.9 2001/01/28 05:47:05 tdb1 Exp $
 */
public class XMLPacketMaker extends HandlerBase {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.9 $";
    
//---STATIC METHODS---

//---CONSTRUCTORS---

    /**
     * Constructor for accepting XML input.
     *
     * @param xml A String of XML to process.
     */
    public XMLPacketMaker (String xml) {
        _xml = xml;
    }

//---PUBLIC METHODS---

    /**
     * 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));
            SAXParser saxParser = factory.newSAXParser();
            saxParser.parse(inputSource, new XMLStringParser(packet));
        }
        catch (Exception e) {
            // couldn't parse the XML for some reason
            throw new InvalidXMLException("Could not parse the XML: "+_xml);
        }
        // parsed successfully, return the packet
        return packet;
    }

    /**
     * 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 FormatName.getName(
            _name,
            getClass().getName(),
            REVISION);
    }

//---PRIVATE METHODS---

//---ACCESSOR/MUTATOR METHODS---

//---ATTRIBUTES---

    /**
     * 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---

}
Revision:	1.10
Committed:	Thu Mar 1 16:55:11 2001 UTC (23 years, 2 months ago) by tdb
Branch:	MAIN
Changes since 1.9:	+7 -7 lines
Log Message:	Now throws an InvalidXMLException if the XML String cannot be parsed.
#	User	Rev	Content
1	ajm	1.7	//---PACKAGE DECLARATION---
2			package uk.ac.ukc.iscream.util;
3
4			//---IMPORTS---
5			import java.io.*;
6			import java.util.ArrayList;
7
8			import org.xml.sax.*;
9			import javax.xml.parsers.SAXParserFactory;
10			import javax.xml.parsers.ParserConfigurationException;
11			import javax.xml.parsers.SAXParser;
12
13			/**
14			* XMLPacketMaker - Creates an XMLPacket object.
15			*
16	tdb	1.9	* @author $Author: tdb1 $
17	tdb	1.10	* @version $Id: XMLPacketMaker.java,v 1.9 2001/01/28 05:47:05 tdb1 Exp $
18	ajm	1.7	*/
19			public class XMLPacketMaker extends HandlerBase {
20
21			//---FINAL ATTRIBUTES---
22
23			/**
24			* The current CVS revision of this class
25			*/
26	tdb	1.10	public final String REVISION = "$Revision: 1.9 $";
27	ajm	1.7
28			//---STATIC METHODS---
29
30			//---CONSTRUCTORS---
31
32	tdb	1.9	/**
33			* Constructor for accepting XML input.
34			*
35			* @param xml A String of XML to process.
36			*/
37	ajm	1.7	public XMLPacketMaker (String xml) {
38			_xml = xml;
39			}
40
41			//---PUBLIC METHODS---
42
43	tdb	1.9	/**
44			* Method to create an XML packet from the data this
45			* class was constructed with.
46			*
47			* @return an XMLPacket representing the XML String given
48	tdb	1.10	* @throws InvalidXMLException if the XML cannot be parsed
49	tdb	1.9	*/
50	tdb	1.10	public XMLPacket createXMLPacket() throws InvalidXMLException {
51	ajm	1.7
52			// Create the XMLPacket to store values in.
53			XMLPacket packet = new XMLPacket();
54
55			// Use the default (non-validating) parser
56			SAXParserFactory factory = SAXParserFactory.newInstance();
57			try {
58			// Parse the input
59			InputSource inputSource = new InputSource(new StringReader(_xml));
60			SAXParser saxParser = factory.newSAXParser();
61			saxParser.parse(inputSource, new XMLStringParser(packet));
62			}
63			catch (Exception e) {
64	tdb	1.10	// couldn't parse the XML for some reason
65			throw new InvalidXMLException("Could not parse the XML: "+_xml);
66	ajm	1.7	}
67	tdb	1.10	// parsed successfully, return the packet
68	ajm	1.7	return packet;
69			}
70
71			/**
72			* Overrides the {@link java.lang.Object#toString() Object.toString()}
73			* method to provide clean logging (every class should have this).
74			*
75			* This uses the uk.ac.ukc.iscream.util.NameFormat class
76			* to format the toString()
77			*
78			* @return the name of this class and its CVS revision
79			*/
80			public String toString() {
81			return FormatName.getName(
82			_name,
83			getClass().getName(),
84			REVISION);
85			}
86
87			//---PRIVATE METHODS---
88
89			//---ACCESSOR/MUTATOR METHODS---
90
91			//---ATTRIBUTES---
92
93			/**
94			* Holds the xml
95			*/
96			String _xml;
97
98			/**
99			* This is the friendly identifier of the
100			* component this class is running in.
101			* eg, a Filter may be called "filter1",
102			* If this class does not have an owning
103			* component, a name from the configuration
104			* can be placed here. This name could also
105			* be changed to null for utility classes.
106			*/
107			private String _name = null;
108
109			//---STATIC ATTRIBUTES---
110
111			}