ifs.fnd.util

Class XmlUtil

java.lang.Object

ifs.fnd.util.XmlUtil

public class XmlUtil
extends java.lang.Object

Common class with diverse XML utility functions.

Since:

5.0.0

Method Summary

Modifier and Type	Method and Description
static org.w3c.dom.Element	findElement(org.w3c.dom.Element parent, java.lang.String tagName, boolean deep) Search for an element in a node
static java.lang.String	formatDocument(org.w3c.dom.Document doc, java.lang.String encoding, boolean pretty) Formatting an XML document to a String
static void	formatDocument(org.w3c.dom.Document doc, java.lang.String encoding, boolean pretty, java.io.Writer writer) Formatting an XML document to a stream.
static byte[]	formatDocumentToByteArray(org.w3c.dom.Document doc, java.lang.String encoding, boolean pretty) Formatting an XML document to a byte array
static javax.xml.transform.TransformerFactory	newTransformerFactory() Creates a new instance of TransformerFactory.
static javax.xml.stream.XMLEventFactory	newXMLEventFactory() Creates a new instance of the StAX XMLEventFactory.
static javax.xml.stream.XMLInputFactory	newXMLInputFactory() Creates a new instance of the StAX XMLInputFactory.
static javax.xml.stream.XMLOutputFactory	newXMLOutputFactory() Creates a new instance of the StAX XMLOutputFactory.
static org.w3c.dom.Document	parseDocument(org.xml.sax.InputSource input) Parses an XML document from a strem

Methods inherited from class java.lang.Object

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

Method Detail

newTransformerFactory

public static javax.xml.transform.TransformerFactory newTransformerFactory()

Creates a new instance of TransformerFactory. This is just a wrapping of javax.xml.transform.TransformerFactory.newInstance() where you can override the default factory implementation by specifying which factory implementation to use in ifs.properties fnd.transformerFactory.

If this property has not been set the behavior is exactly as for javax.xml.transform.TransformerFactory.newInstance().

Returns:

newXMLInputFactory

public static javax.xml.stream.XMLInputFactory newXMLInputFactory()
                                                           throws javax.xml.stream.FactoryConfigurationError

Creates a new instance of the StAX XMLInputFactory. Convenient method that wraps javax.xml.stream.XMLInputFactory.newInstance().

Returns:

the factory implementation

Throws:

javax.xml.stream.FactoryConfigurationError - if an instance of this factory cannot be loaded

newXMLOutputFactory

public static javax.xml.stream.XMLOutputFactory newXMLOutputFactory()
                                                             throws javax.xml.stream.FactoryConfigurationError

Creates a new instance of the StAX XMLOutputFactory. Convenient method that wraps javax.xml.stream.XMLOutputFactory.newInstance().

Returns:

the factory implementation

Throws:

javax.xml.stream.FactoryConfigurationError - if an instance of this factory cannot be loaded

newXMLEventFactory

public static javax.xml.stream.XMLEventFactory newXMLEventFactory()
                                                           throws javax.xml.stream.FactoryConfigurationError

Creates a new instance of the StAX XMLEventFactory. Convenient method that wraps javax.xml.stream.XMLEventFactory.newInstance().

Returns:

the factory implementation

Throws:

javax.xml.stream.FactoryConfigurationError - if an instance of this factory cannot be loaded

formatDocument

public static void formatDocument(org.w3c.dom.Document doc,
                                  java.lang.String encoding,
                                  boolean pretty,
                                  java.io.Writer writer)
                           throws java.io.IOException

Formatting an XML document to a stream.

Parameters:

doc - The xml document

encoding - The encoding of the document (example "UTF-8")

pretty - Flag that set format style of the xml-string to pretty

writer - Writer that writes the serialized document to the output stream

Throws:

java.io.IOException

formatDocument

public static java.lang.String formatDocument(org.w3c.dom.Document doc,
                                              java.lang.String encoding,
                                              boolean pretty)
                                       throws java.io.IOException

Formatting an XML document to a String

Parameters:

doc - The xml document

encoding - The encoding of the document (example "UTF-8")

pretty - Flag that set format style of the xml-string to pretty

Returns:

String containing the document

Throws:

java.io.IOException

formatDocumentToByteArray

public static byte[] formatDocumentToByteArray(org.w3c.dom.Document doc,
                                               java.lang.String encoding,
                                               boolean pretty)
                                        throws java.io.IOException

Formatting an XML document to a byte array

Parameters:

doc - The xml document

encoding - The encoding of the document (example "UTF-8")

pretty - Flag that set format style of the xml-string to pretty

Returns:

The document formatted to a byte array

Throws:

java.io.IOException

parseDocument

public static org.w3c.dom.Document parseDocument(org.xml.sax.InputSource input)
                                          throws java.io.IOException

Parses an XML document from a strem

Parameters:

input - Serialized XML document

Returns:

Resulting XML document

Throws:

java.io.IOException

findElement

public static org.w3c.dom.Element findElement(org.w3c.dom.Element parent,
                                              java.lang.String tagName,
                                              boolean deep)

Search for an element in a node

Parameters:

parent - The parent element

tagName - The tagName to search for

deep - If false only direct children (one level)

Returns:

The found element