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 org.xml.sax.helpers.*;
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.14 2001/03/09 19:14:01 tdb1 Exp $
 */
public class XMLPacketMaker {

//---FINAL ATTRIBUTES---

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