org.sbml.jsbml.util

Interface DocumentFactory

All Known Implementing Classes:

JAXPFacade

public interface DocumentFactory

* An interface for XML DOM document factories.

Since:

0.8

Version:

$Rev$

Author:

Marco Donizelli

Method Summary

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.

Method Detail

create

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.

Parameters:

byteStream - The byte 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 byteStream XML content.

Throws:

org.xml.sax.SAXException

create

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.

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 exception is most likely to be thrown by the underlying implementation.

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

create

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.

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

create

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.

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 exception is most likely to be thrown by the underlying implementation.

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.