org.sbml.jsbml.util

Class JAXPFacade

java.lang.Object

org.sbml.jsbml.util.JAXPFacade

All Implemented Interfaces:

DocumentFactory, NodeWriter, SAX2Parser

public class JAXPFacade
extends java.lang.Object
implements DocumentFactory, SAX2Parser, NodeWriter

A convenient Facade to parse and write byte and character streams with XML content using the interfaces and classes defined by the JAXP specification.

Since:

0.8

Version:

$Rev: 1639 $

Author:

Marco Donizelli

See Also:

DocumentFactory, SAX2Parser, NodeWriter

Field Summary

Fields

Modifier and Type	Field and Description
private static JAXPFacade	instance_
private static javax.xml.transform.TransformerFactory	transformer_factory

Constructor Summary

Constructors

Modifier	Constructor and Description
private	JAXPFacade()

Method Summary

Methods

Modifier and Type	Method and Description
org.w3c.dom.Document	create(java.io.InputStream byteStream, boolean namespaceAware) Creates an XML DOM document by parsing the content of the specified byte stream as XML, using a nonvalidating parser.
org.w3c.dom.Document	create(java.io.InputStream byteStream, java.lang.Object[] schemas, org.xml.sax.ErrorHandler handler) Creates an XML DOM document by parsing the content of the specified byte stream as XML, using a validating parser.
org.w3c.dom.Document	create(java.io.Reader characterStream, boolean namespaceAware) Creates an XML DOM document by parsing the content of the specified character stream as XML, using a nonvalidating parser.
org.w3c.dom.Document	create(java.io.Reader characterStream, java.lang.Object[] schemas, org.xml.sax.ErrorHandler handler) Creates an XML DOM document by parsing the content of the specified character stream as XML, using a validating parser.
static JAXPFacade	getInstance() Creates and returns a new JAXPFacade.
void	parse(java.io.InputStream byteStream, org.xml.sax.helpers.DefaultHandler handler, boolean namespaceAware) Parses the content of a byte stream as XML, using a nonvalidating parser and the specified SAX2 default event handler.
void	parse(java.io.InputStream byteStream, org.xml.sax.helpers.DefaultHandler handler, java.lang.Object[] schemas) Parses the content of a byte stream as XML, using a validating parser and the specified SAX2 default event handler.
void	parse(java.io.Reader characterStream, org.xml.sax.helpers.DefaultHandler handler, boolean namespaceAware) Parses the content of a character stream as XML, using a nonvalidating parser and the specified SAX2 default event handler.
void	parse(java.io.Reader characterStream, org.xml.sax.helpers.DefaultHandler handler, java.lang.Object[] schemas) Parses the content of a character stream as XML, using a validating parser and the specified SAX2 default event handler.
void	write(org.w3c.dom.Node node, java.io.OutputStream byteStream, boolean indent) Writes an XML DOM node to the specified byte stream.
void	write(org.w3c.dom.Node node, java.io.OutputStream byteStream, javax.xml.transform.stream.StreamSource streamSource, boolean indent) Writes an XML DOM node to the specified byte stream, using a javax.xml.transform.Transformer instance created from streamSource.
void	write(org.w3c.dom.Node node, java.io.Writer characterStream, boolean indent) Writes an XML DOM node to the specified character stream.
static void	write(org.w3c.dom.Node node, java.io.Writer characterStream, javax.xml.transform.stream.StreamSource streamSource, boolean indent) Writes an XML DOM node to the specified character stream, using a javax.xml.transform.Transformer instance created from streamSource.

Methods inherited from class java.lang.Object

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

Field Detail

instance_

private static JAXPFacade instance_

transformer_factory

private static javax.xml.transform.TransformerFactory transformer_factory

Constructor Detail

JAXPFacade

private JAXPFacade()

Method Detail

getInstance

public static JAXPFacade getInstance()

Creates and returns a new JAXPFacade.

Returns:

A new JAXPFacade.

write

public static void write(org.w3c.dom.Node node,
         java.io.Writer characterStream,
         javax.xml.transform.stream.StreamSource streamSource,
         boolean indent)

Writes an XML DOM node to the specified character stream, using a javax.xml.transform.Transformer instance created from streamSource.

Parameters:

node - The org.w3c.dom.Node instance representing the XML DOM node to be written to characterStream.

characterStream - The character stream where node is to be written.

streamSource - An object that holds an URI, input stream, etc.

indent - Flag to indicate whether the output should be indented or not.

Throws:

java.lang.NullPointerException - If node or characterStream are null.

java.lang.RuntimeException - If any error occurs (transformer configuration errors, transformer errors).

create

public org.w3c.dom.Document create(java.io.InputStream byteStream,
                          boolean namespaceAware)
                            throws org.xml.sax.SAXException

Creates an XML DOM document by parsing the content of the specified byte stream as XML, using a nonvalidating parser.

Specified by:

create in interface DocumentFactory

Parameters:

byteStream - The byte stream which content is parsed as XML to create the XML DOM document.

namespaceAware - A flag to indicate whether the parser should know about namespaces or not.

Returns:

The org.w3c.dom.Document instance representing the XML DOM document created from the byteStream XML content.

Throws:

org.xml.sax.SAXException

java.lang.NullPointerException - If byteStream is null.

java.lang.RuntimeException - If any error occurs (parser configuration errors, I/O errors, SAX parsing errors).

create

public org.w3c.dom.Document create(java.io.InputStream byteStream,
                          java.lang.Object[] schemas,
                          org.xml.sax.ErrorHandler handler)
                            throws org.xml.sax.SAXException

Creates an XML DOM document by parsing the content of the specified byte stream as XML, using a validating parser.

Specified by:

create in interface DocumentFactory

Parameters:

byteStream - The byte stream whose content is parsed as XML to create the XML DOM document.

schemas - An optional array of either java.io.File instances containing the abstract pathnames, or of java.io.String instances containing the URIs, pointing to the schemas to use in the validation process. If set to null, the schemas defined in the data set will be used. If set to null and no schemas are found in the data set, an org.xml.sax.SAXParseException is thrown.

handler - The error handler to be used to report errors occurred while parsing the byteStream XML content. Setting this to null will result in the underlying implementation using it's own default implementation and behavior.

Returns:

The org.w3c.dom.Document instance representing the XML DOM document created from the byteStream XML content.

Throws:

org.xml.sax.SAXException

java.lang.NullPointerException - If byteStream is null.

java.lang.RuntimeException - If any error occurs (parser configuration errors, I/O errors, SAX parsing errors).

create

public org.w3c.dom.Document create(java.io.Reader characterStream,
                          boolean namespaceAware)
                            throws org.xml.sax.SAXException

Creates an XML DOM document by parsing the content of the specified character stream as XML, using a nonvalidating parser.

Specified by:

create in interface DocumentFactory

Parameters:

characterStream - The character stream whose content is parsed as XML to create the XML DOM document.

namespaceAware - A flag to indicate whether the parser should know about namespaces or not.

Returns:

The org.w3c.dom.Document instance representing the XML DOM document created from the characterStream XML content.

Throws:

org.xml.sax.SAXException

java.lang.NullPointerException - If characterStream is null.

java.lang.RuntimeException - If any error occurs (parser configuration errors, I/O errors, SAX parsing errors).

create

public org.w3c.dom.Document create(java.io.Reader characterStream,
                          java.lang.Object[] schemas,
                          org.xml.sax.ErrorHandler handler)

Creates an XML DOM document by parsing the content of the specified character stream as XML, using a validating parser.

Specified by:

create in interface DocumentFactory

Parameters:

characterStream - The character stream whose content is parsed as XML to create the XML DOM document.

schemas - An optional array of either java.io.File instances containing the abstract pathnames, or of java.io.String instances containing the URIs, pointing to the schemas to use in the validation process. If set to null, the schemas defined in the data set will be used. If set to null and no schemas are found in the data set, an org.xml.sax.SAXParseException is thrown.

handler - The error handler to be used to report errors occurred while parsing the characterStream XML content. Setting this to null will result in the underlying implementation using it's own default implementation and behavior.

Returns:

The org.w3c.dom.Document instance representing the XML DOM document created from the characterStream XML content.

Throws:

java.lang.NullPointerException - If characterStream is null.

java.lang.RuntimeException - If any error occurs (parser configuration errors, I/O errors, SAX parsing errors).

parse

public void parse(java.io.InputStream byteStream,
         org.xml.sax.helpers.DefaultHandler handler,
         boolean namespaceAware)

Parses the content of a byte stream as XML, using a nonvalidating parser and the specified SAX2 default event handler.

Specified by:

parse in interface SAX2Parser

Parameters:

byteStream - The byte stream which content has to be parsed as XML.

handler - The SAX2 default event handler to use for parsing byteStream.

namespaceAware - A flag to indicate whether the parser should know about namespaces or not.

Throws:

java.lang.NullPointerException - If byteStream or handler are null.

java.lang.RuntimeException - If any error occurs (parser configuration errors, I/O errors, SAX parsing errors).

parse

public void parse(java.io.InputStream byteStream,
         org.xml.sax.helpers.DefaultHandler handler,
         java.lang.Object[] schemas)

Parses the content of a byte stream as XML, using a validating parser and the specified SAX2 default event handler.

Specified by:

parse in interface SAX2Parser

Parameters:

byteStream - The byte stream which content has to be parsed as XML.

handler - The SAX2 default event handler to use for parsing byteStream.

schemas - An optional array of either java.io.File instances containing the abstract pathnames, or of java.io.String instances containing the URIs, pointing to the schemas to use in the validation process. If set to null, the schemas defined in the data set will be used. If set to null and no schemas are found in the data set, an org.xml.sax.SAXParseException is thrown.

Throws:

java.lang.NullPointerException - If byteStream or handler are null.

java.lang.RuntimeException - If any error occurs (parser configuration errors, I/O errors, SAX parsing errors).

parse

public void parse(java.io.Reader characterStream,
         org.xml.sax.helpers.DefaultHandler handler,
         boolean namespaceAware)

Parses the content of a character stream as XML, using a nonvalidating parser and the specified SAX2 default event handler.

Specified by:

parse in interface SAX2Parser

Parameters:

characterStream - The character stream which content has to be parsed as XML.

handler - The SAX2 default event handler to use for parsing characterStream.

namespaceAware - A flag to indicate whether the parser should know about namespaces or not.

Throws:

java.lang.NullPointerException - If characterStream or handler are null.

java.lang.RuntimeException - If any error occurs (parser configuration errors, I/O errors, SAX parsing errors).

parse

public void parse(java.io.Reader characterStream,
         org.xml.sax.helpers.DefaultHandler handler,
         java.lang.Object[] schemas)

Parses the content of a character stream as XML, using a validating parser and the specified SAX2 default event handler.

Specified by:

parse in interface SAX2Parser

Parameters:

characterStream - The character stream which content has to be parsed as XML.

handler - The SAX2 default event handler to use for parsing characterStream.

schemas - An optional array of either java.io.File instances containing the abstract pathnames, or of java.io.String instances containing the URIs, pointing to the schemas to use in the validation process. If set to null, the schemas defined in the data set will be used. If set to null and no schemas are found in the data set, an org.xml.sax.SAXParseException is thrown.

Throws:

java.lang.NullPointerException - If characterStream or handler are null.

java.lang.RuntimeException - If any error occurs (parser configuration errors, I/O errors, SAX parsing errors).

write

public void write(org.w3c.dom.Node node,
         java.io.OutputStream byteStream,
         boolean indent)

Writes an XML DOM node to the specified byte stream.

Specified by:

write in interface NodeWriter

Parameters:

node - The org.w3c.dom.Node instance representing the XML DOM node to be written to byteStream.

byteStream - The byte stream where node is to be written.

indent - Flag to indicate whether the output should be indented or not.

Throws:

java.lang.NullPointerException - If node or byteStream are null.

java.lang.RuntimeException - If any error occurs (transformer configuration errors, transformer errors).

write

public void write(org.w3c.dom.Node node,
         java.io.OutputStream byteStream,
         javax.xml.transform.stream.StreamSource streamSource,
         boolean indent)

Writes an XML DOM node to the specified byte stream, using a javax.xml.transform.Transformer instance created from streamSource.

Parameters:

node - The org.w3c.dom.Node instance representing the XML DOM node to be written to byteStream.

byteStream - The byte stream where node is to be written.

streamSource - An object that holds an URI, input stream, etc.

indent - Flag to indicate whether the output should be indented or not.

Throws:

java.lang.NullPointerException - If node or byteStream are null.

java.lang.RuntimeException - If any error occurs (transformer configuration errors, transformer errors).

write

public void write(org.w3c.dom.Node node,
         java.io.Writer characterStream,
         boolean indent)

Writes an XML DOM node to the specified character stream.

Specified by:

write in interface NodeWriter

Parameters:

node - The org.w3c.dom.Node instance representing the XML DOM node to be written to characterStream.

characterStream - The character stream where node is to be written.

indent - Flag to indicate whether the output should be indented or not.

Throws:

java.lang.NullPointerException - If node or characterStream are null.

java.lang.RuntimeException - If any error occurs (transformer configuration errors, transformer errors).