gov.llnl.babel.parsers.xml

Class ParseSymbolXML

java.lang.Object

gov.llnl.babel.parsers.xml.ParseSymbolXML

public class ParseSymbolXML
extends java.lang.Object

Class ParseSymbolXML converts an XML document into a SIDL symbol. Utility function convert takes either an input stream or a validated DOM tree and generates a SIDL symbol. Any errors in format generate a ParseSymbolException.

Constructor Summary

Constructors

Constructor and Description
ParseSymbolXML(org.w3c.dom.Document doc, Context context) Create a DOM document to SIDL symbol converter object.
ParseSymbolXML(org.xml.sax.InputSource is, Context context) Create an XML input stream to SIDL symbol converter object.

Method Summary

Methods

Modifier and Type	Method and Description
static Symbol	convert(org.w3c.dom.Document doc, Context context) This is a convenience utility function that converts a DOM document into a SIDL symbol.
static Symbol	convert(org.xml.sax.InputSource is, Context context) This is a convenience utility function that converts an XML input stream into a SIDL symbol.
Symbol	getSymbol() Return the SIDL symbol for the XML or DOM given in the constructor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParseSymbolXML

public ParseSymbolXML(org.xml.sax.InputSource is,
              Context context)
               throws ParseSymbolException

Create an XML input stream to SIDL symbol converter object. The constructor parses the XML input stream and then converts the DOM structure into a symbol. The resulting symbol may be read by a call to getSymbol. Any errors will throw a parse symbol exception.

Parameters:

is - The input stream to use for conversion.

Throws:

ParseSymbolException - The exception raised if a parsing error is encountered.

ParseSymbolXML

public ParseSymbolXML(org.w3c.dom.Document doc,
              Context context)
               throws ParseSymbolException

Create a DOM document to SIDL symbol converter object. The DOM document must be a valid representation of a SIDL symbol. The resulting symbol may be read by a call to getSymbol.

Parameters:

doc - The DOM document to be converted.

Throws:

ParseSymbolException - The exception raised if a parsing error is encountered.

Method Detail

convert

public static Symbol convert(org.xml.sax.InputSource is,
             Context context)
                      throws ParseSymbolException

This is a convenience utility function that converts an XML input stream into a SIDL symbol. Any errors detected in the XML input are converted into a ParseSymbolException. Since this method is static, it may be called without explicity creating an object.

Parameters:

is - The input stream to use for conversion.

Throws:

ParseSymbolException - The exception raised if a parsing error is encountered.

convert

public static Symbol convert(org.w3c.dom.Document doc,
             Context context)
                      throws ParseSymbolException

This is a convenience utility function that converts a DOM document into a SIDL symbol. This method assumes that the DOM document is a valid symbol representation. Any errors detected in the DOM input are converted into a ParseSymbolException. Since this method is static, it may be called without explicity creating an object.

Parameters:

doc - The DOM document to be converted.

Throws:

ParseSymbolException - The exception raised if a parsing error is encountered.

getSymbol

public Symbol getSymbol()

Return the SIDL symbol for the XML or DOM given in the constructor.