com.ibm.ctc.b2b.xml

Class CustomDocumentBuilder

java.lang.Object

com.ibm.ctc.b2b.xml.CustomDocumentBuilder

public class CustomDocumentBuilder
extends java.lang.Object

This is a convenience static class for creating DOM4J documents.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	CLASSNAME
(package private) static java.lang.String	COPYRIGHT
private static org.apache.log4j.Logger	logger

Constructor Summary

Constructors

Modifier	Constructor and Description
private	CustomDocumentBuilder() Private ctor to prevent instatiation, this is a static class.

Method Summary

Modifier and Type	Method and Description
static org.dom4j.Document	build(boolean validate, java.io.File xml) Creates an object representation of an XML file.
private static org.dom4j.Document	build(boolean validate, org.xml.sax.InputSource is) Creates an object representation of an XML file.
static org.dom4j.Document	build(boolean validate, java.lang.String xml) Creates an object representation of an XML file.
static org.dom4j.Document	createShellDocument() Creates a XML document containing an empty cXML tag.
static void	dumpDocument(org.dom4j.Document theDoc) Dumps the document contents to stdout.
static void	dumpDocumentTwice(org.dom4j.Document theDoc) Dumps the document contents to stdout, first without replacing HTML chars, then replacing special HTML chars with built-ins.
static java.lang.String	parseToString(org.dom4j.Document theDoc, boolean isCompact, boolean escapeHtmlChars) Builds a String representation of the XML document.
private static java.lang.StringBuffer	parseToStringBuffer(org.dom4j.Document theDoc, boolean isCompact)
private static void	replaceInBuffer(java.lang.StringBuffer buffer, java.lang.String charToReplace, java.lang.String replacement)

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

CLASSNAME

private static final java.lang.String CLASSNAME

logger

private static org.apache.log4j.Logger logger

Constructor Detail

CustomDocumentBuilder

private CustomDocumentBuilder()

Private ctor to prevent instatiation, this is a static class.

Method Detail

build

public static org.dom4j.Document build(boolean validate,
                                       java.lang.String xml)
                                throws B2bException

Creates an object representation of an XML file.

Parameters:

validate - true to create a validating document

xml - String which contains the XML content

Returns:

document object

Throws:

B2bException

build

public static org.dom4j.Document build(boolean validate,
                                       java.io.File xml)
                                throws B2bException

Creates an object representation of an XML file.

Parameters:

validate - true to create a validating document

xml - file which contains the XML content

Returns:

document object

Throws:

B2bException

build

private static org.dom4j.Document build(boolean validate,
                                        org.xml.sax.InputSource is)
                                 throws B2bException

Creates an object representation of an XML file.

Parameters:

validate - true to create a validating document

is - Source which contains the XML content

Returns:

document object

Throws:

B2bException

createShellDocument

public static org.dom4j.Document createShellDocument()
                                              throws java.lang.Exception

Creates a XML document containing an empty cXML tag.

Returns:

the cXML document

Throws:

java.lang.Exception

dumpDocumentTwice

public static void dumpDocumentTwice(org.dom4j.Document theDoc)

Dumps the document contents to stdout, first without replacing HTML chars, then replacing special HTML chars with built-ins.

Parameters:

theDoc - to dump

dumpDocument

public static void dumpDocument(org.dom4j.Document theDoc)

Dumps the document contents to stdout.

Parameters:

theDoc - to dump

parseToString

public static java.lang.String parseToString(org.dom4j.Document theDoc,
                                             boolean isCompact,
                                             boolean escapeHtmlChars)
                                      throws javax.xml.transform.TransformerException

Builds a String representation of the XML document.

Parameters:

theDoc - XML document to parse

isCompact - true for a shorter representation (no indentation)

escapeHtmlChars - true if special HTML characters are replaced with character entities

Returns:

String representation of theDoc

Throws:

javax.xml.transform.TransformerException - if an error occurs

replaceInBuffer

private static void replaceInBuffer(java.lang.StringBuffer buffer,
                                    java.lang.String charToReplace,
                                    java.lang.String replacement)

Parameters:

buffer -

charToReplace -

replacement -

parseToStringBuffer

private static java.lang.StringBuffer parseToStringBuffer(org.dom4j.Document theDoc,
                                                          boolean isCompact)
                                                   throws javax.xml.transform.TransformerConfigurationException,
                                                          javax.xml.transform.TransformerFactoryConfigurationError,
                                                          javax.xml.transform.TransformerException

Parameters:

theDoc -

isCompact -

Returns:

StringBuffer

Throws:

javax.xml.transform.TransformerConfigurationException

javax.xml.transform.TransformerFactoryConfigurationError

javax.xml.transform.TransformerException