com.tangosol.run.xml
Class SaxParser

java.lang.Object
  com.tangosol.util.Base
      com.tangosol.run.xml.SaxParser

public class SaxParser
extends Base

A simple XML parser. The public interface consists of nearly identical methods: parseXml(...) which produce a tree of SimpleElement objects

Author:

gg 2000.10.23

Constructor Summary

SaxParser()
Construct a SaxParser.

SaxParser(boolean fAllowComments)
Construct a SaxParser.

Method Summary

protected static Parser	getParser() Get an instance of non-validating SAX parser
protected XmlElement	instantiateRoot(String sRoot) Instantiate an XmlElement implementation for a root element.
static void	main(String[] asParam) Unit test: create a simple parser, parse and output the result
XmlElement	parseXml(InputSource input) Parse the specified InputSource into a tree of XmlElement objects ignoring any XML nodes other then elements, text or comments (in a case of SaxParser that allows comments).
protected XmlElement	parseXml(InputSource input, XmlElement xmlRoot)
XmlElement	parseXml(InputStream input) Parse the specified InputStream into a tree of XmlElement objects ignoring any XML nodes other then elements, text or comments (in a case of SaxParser that allows comments).
XmlElement	parseXml(Reader input) Parse the specified Reader into a tree of XmlElement objects ignoring any XML nodes other then elements, text or comments (in a case of SaxParser that allows comments).
XmlElement	parseXml(String sXml) Parse the specified String into a tree of XmlElement objects ignoring any XML nodes other then elements, text or comments (in a case of SaxParser that allows comments).
XmlElement	parseXml(String sXml, XmlElement elRoot) Parse the specified String into a tree of XmlElement objects (same as above) having the specified [empty] XmlElement a root Note: this method is used by de-serialization (see SimpleElement#readExternal)

Constructor Detail

SaxParser

public SaxParser()

Construct a SaxParser.

SaxParser

public SaxParser(boolean fAllowComments)

Construct a SaxParser.

Parameters:

fAllowComments - if true, the resulting tree may contain the XMLValue nodes that contain comments; otherwize all comments are ignored

Method Detail

main

public static void main(String[] asParam)

Unit test: create a simple parser, parse and output the result

parseXml

public XmlElement parseXml(String sXml)
                    throws SAXException

Parse the specified String into a tree of XmlElement objects ignoring any XML nodes other then elements, text or comments (in a case of SaxParser that allows comments). In addition, the text value is trimmed for all nodes except leafs.

Throws:

SAXException

parseXml

public XmlElement parseXml(String sXml,
                           XmlElement elRoot)
                    throws SAXException

Parse the specified String into a tree of XmlElement objects (same as above) having the specified [empty] XmlElement a root Note: this method is used by de-serialization (see SimpleElement#readExternal)

Throws:

SAXException

parseXml

public XmlElement parseXml(InputStream input)
                    throws SAXException

Parse the specified InputStream into a tree of XmlElement objects ignoring any XML nodes other then elements, text or comments (in a case of SaxParser that allows comments). In addition, the text value is trimmed for all nodes except leafs.

Throws:

SAXException

parseXml

public XmlElement parseXml(Reader input)
                    throws SAXException

Parse the specified Reader into a tree of XmlElement objects ignoring any XML nodes other then elements, text or comments (in a case of SaxParser that allows comments). In addition, the text value is trimmed for all nodes except leafs.

Throws:

SAXException

parseXml

public XmlElement parseXml(InputSource input)
                    throws SAXException

Parse the specified InputSource into a tree of XmlElement objects ignoring any XML nodes other then elements, text or comments (in a case of SaxParser that allows comments). In addition, the text value is trimmed for all nodes except leafs.

Throws:

SAXException

parseXml

protected XmlElement parseXml(InputSource input,
                              XmlElement xmlRoot)
                       throws SAXException

Throws:

SAXException

instantiateRoot

protected XmlElement instantiateRoot(String sRoot)

Instantiate an XmlElement implementation for a root element.

Parameters:

sRoot - root name

Returns:

a new XmlElement to be used as the root element

getParser

protected static Parser getParser()
                           throws Exception

Get an instance of non-validating SAX parser

Throws:

Exception