org.mdiutil.xml.tree.dom

Class XMLDocumentBuilderFactory

java.lang.Object

org.mdiutil.xml.tree.dom.XMLDocumentBuilderFactory

public class XMLDocumentBuilderFactory
extends Object

This factory allows to create a DOM Document with an XMLRoot or a File, URL or String. This class works similarly to the DocumentBuilderFactory class in the JDK.

Method Summary

Modifier and Type	Method and Description
EntityListResolver	getEntityListResolver() Return the EntityListResolver which can manage entity resolution in XML files.
ErrorHandler	getErrorHandler() Return the error handler wich will be fired for parsing errors detected by the underlying parser.
int	getIndentation() Return the Document indentation.
URL	getSchema() Return the schema of the underlying parser.
boolean	isKeepingAttributesOrder() Return true if the order of attributes in the input XML structure should be preserved in the Document.
boolean	isNamespaceAware() Return true if the creation of the Document should be namespace-aware.
boolean	isPreservingSpace() Return true if spaces should be preserved when creating the Document.
boolean	isShowingExceptions() Return true if exceptions should be shown when creating the Document.
boolean	isShowingWarnings() Return true if warnings should be shown when creating the Document.
boolean	isValidating() Return true if the underlying parser is validating.
void	keepAttributesOrder(boolean keepAttributesOrder) Set if the order of attributes in the input XML structure should be preserved in the Document.
static XMLDocumentBuilderFactory	newInstance() Return a new instance.
Document	parse(File file) Create a document from a File.
Document	parse(InputStream stream) Create a document from an InputStream.
Document	parse(Reader reader) Create a document from a Reader.
Document	parse(String xml) Create a document from an XML String content.
Document	parse(URL url) Create a document from a URL.
Document	parse(XMLRoot root) Create a document from an XML tree.
void	setEntityListResolver(EntityListResolver resolver) Set the EntityListResolver which can manage entity resolution in XML files.
void	setErrorHandler(ErrorHandler errorHandler) Set an error handler wich will be fired for parsing errors detected by the underlying parser.
void	setIndentation(int indentation) Set the Document indentation.
void	setNamespaceAware(boolean namespaceAware) Set if the creation of the Document should be namespace-aware.
void	setPreserveSpace(boolean preserveSpace) Set if spaces should be preserved when creating the Document.
void	setSchema(URL schema) Set the schema of the underlying parser.
void	setShowExceptions(boolean showExceptions) Set if exceptions should be shown when creating the Document.
void	setShowWarnings(boolean showWarnings) Set if warnings should be shown when creating the Document.
void	setValidating(boolean isValidating) Set if the underlying parser is validating.

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static XMLDocumentBuilderFactory newInstance()

Return a new instance.

Returns:

the instance

parse

public Document parse(File file)

Create a document from a File.

Parameters:

file - the File

Returns:

the Document

parse

public Document parse(URL url)

Create a document from a URL.

Parameters:

url - the URL

Returns:

the Document

parse

public Document parse(InputStream stream)

Create a document from an InputStream.

Parameters:

stream - the InputStream

Returns:

the Document

parse

public Document parse(Reader reader)

Create a document from a Reader.

Parameters:

reader - the Reader

Returns:

the Document

parse

public Document parse(String xml)

Create a document from an XML String content.

Parameters:

xml - the XML String content

Returns:

the Document

parse

public Document parse(XMLRoot root)

Create a document from an XML tree.

Parameters:

root - the root node

Returns:

the Document

setEntityListResolver

public void setEntityListResolver(EntityListResolver resolver)

Set the EntityListResolver which can manage entity resolution in XML files.

Parameters:

resolver - the resolver

getEntityListResolver

public EntityListResolver getEntityListResolver()

Return the EntityListResolver which can manage entity resolution in XML files.

Returns:

the resolver

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

Set an error handler wich will be fired for parsing errors detected by the underlying parser.

Parameters:

errorHandler - the error handler

getErrorHandler

public ErrorHandler getErrorHandler()

Return the error handler wich will be fired for parsing errors detected by the underlying parser.

Returns:

the error handler

setShowExceptions

public void setShowExceptions(boolean showExceptions)

Set if exceptions should be shown when creating the Document.

Parameters:

showExceptions - true if exceptions should be shown when creating the Document

isShowingExceptions

public boolean isShowingExceptions()

Return true if exceptions should be shown when creating the Document.

Returns:

true if exceptions should be shown when creating the Document

setShowWarnings

public void setShowWarnings(boolean showWarnings)

Set if warnings should be shown when creating the Document.

Parameters:

showWarnings - true if warnings should be shown when creating the Document

isShowingWarnings

public boolean isShowingWarnings()

Return true if warnings should be shown when creating the Document.

Returns:

true if warnings should be shown when creating the Document

setSchema

public void setSchema(URL schema)

Set the schema of the underlying parser.

Parameters:

schema - the schema of the underlying parser

getSchema

public URL getSchema()

Return the schema of the underlying parser.

Returns:

the schema of the underlying parser

setValidating

public void setValidating(boolean isValidating)

Set if the underlying parser is validating.

Parameters:

isValidating - true if the underlying parser is validating

isValidating

public boolean isValidating()

Return true if the underlying parser is validating.

Returns:

true if the underlying parser is validating

setPreserveSpace

public void setPreserveSpace(boolean preserveSpace)

Set if spaces should be preserved when creating the Document.

Parameters:

preserveSpace - true if spaces should be preserved when creating the Document

isPreservingSpace

public boolean isPreservingSpace()

Return true if spaces should be preserved when creating the Document.

Returns:

true if spaces should be preserved when creating the Document

setNamespaceAware

public void setNamespaceAware(boolean namespaceAware)

Set if the creation of the Document should be namespace-aware.

Parameters:

namespaceAware - true if the creation of the Document should be namespace-aware

isNamespaceAware

public boolean isNamespaceAware()

Return true if the creation of the Document should be namespace-aware.

Returns:

true if the creation of the Document should be namespace-aware

setIndentation

public void setIndentation(int indentation)

Set the Document indentation.

Parameters:

indentation - the Document indentation

getIndentation

public int getIndentation()

Return the Document indentation.

Returns:

the Document indentation

keepAttributesOrder

public void keepAttributesOrder(boolean keepAttributesOrder)

Set if the order of attributes in the input XML structure should be preserved in the Document.

Parameters:

keepAttributesOrder - true if the order of attributes in the input XML structure should be preserved in the Document

isKeepingAttributesOrder

public boolean isKeepingAttributesOrder()

Return true if the order of attributes in the input XML structure should be preserved in the Document.

Returns:

true if the order of attributes in the input XML structure should be preserved in the Document