de.mhus.lib.core

Class MXml

java.lang.Object

de.mhus.lib.core.MXml

public class MXml
extends Object

MXml class.

Version:

$Id: $Id

Author:

mikehummel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MXml.ElementIterator
static class	MXml.NodeIterator
static interface	MXml.ValueListener

Constructor Summary

Constructors

Constructor and Description
MXml()

Method Summary

Modifier and Type	Method and Description
static void	carveOut(Element element) Remove the element from his parent but append the children instead if it into the parent node - on the same position.
static Document	createDocument() Create and return a empty xml document.
static String	decode(String _in) Decodes a string with encoded characters to a java string.
static String	dump(Node element) Prints information - most technical - of the xml element and its childs and returns it as string.
static void	dump(PrintStream o, Node element) Prints information - most technical - of the xml element and its childs to the stream.
static void	dump(PrintStream out, NodeList nodes) dump.
static void	dump(PrintStream o, Node node, String level) dump.
static String	encode(String _in) Encode the default problematic characters in a string to store it in a xml value.
static CDATASection	findCDataSection(Element a) findCDataSection.
static Element	getElementByPath(Element root, String path) Returns the first found element by path.
static MXml.ElementIterator	getLocalElementIterator(Element root) Returns an iterator of all elements in the given root element on the first level only.
static MXml.ElementIterator	getLocalElementIterator(Element root, String name) Returns an iterator of elements with this name in the given root element on the first level only.
static NodeList	getLocalElements(Element root) Returns a list of all elements in the given root element on the first level only.
static NodeList	getLocalElements(Element root, String name) Returns a list of elements with this name in the given root element on the first level only.
static String	getPathAsString(Node in) Returns the path to the node as string representation, separated with slashes.
static String	getValue(Element root, boolean inner) Returns the text value of a node.
static String	getValue(Element root, MXml.ValueListener listener) Returns the text value of a node.
static String	getValue(Element root, String path, String def) getValue.
static String	innerXml(Node node) Returns the inner XML Structure as string with all tag definitions.
static String	innerXml(Node node, boolean instructions) Returns the inner XML Structure as string with all tag definitions.
static Document	loadXml(InputStream is) Create a XML Document from a stream resource.
static Document	loadXml(Reader file) loadXml.
static Document	loadXml(String xml) Create a XML Document from a string.
static Document	loadXml(String xml, String charset) Create a XML Document from a string.
static String	normalizeName(String key) Normalize the name of attributes or node names.
static MXml.NodeIterator	queryXPath(Node root, String query) Execute an XPATH query for a list of nodes.
static MXml.ElementIterator	queryXPathElements(Node root, String query) Execute an XPATH query for a list of elements.
static String	removeHtmlTags(String txt) removeHtmlTags.
static String	removeTags(String txt) removeTags.
static void	saveXml(Node e, OutputStream out) Write the element into the stream.
static void	saveXml(Node e, Writer out, boolean intend) saveXml.
static String	toString(Node e, boolean intend) toString.
static void	trim(Element element) Remove white spaces in the text nodes.
static String	unicodeEncode(String _in) Encodes the amp and all characters greater then 255 to unicode representation with amp and hash signs.

Methods inherited from class java.lang.Object

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

Constructor Detail

MXml

public MXml()

Method Detail

getValue

public static String getValue(Element root,
                              boolean inner)

Returns the text value of a node.

Parameters:

root - The element where you need the text value from

inner - If true all inner elements are parsed and the text appended

Returns:

null if root is null or the text of the element

getValue

public static String getValue(Element root,
                              MXml.ValueListener listener)

Returns the text value of a node. The listener manipulates the output for different inner notes.

Parameters:

root - a Element object.

listener - a MXml.ValueListener object.

Returns:

null if the root is null or the text

getLocalElements

public static NodeList getLocalElements(Element root,
                                        String name)

Returns a list of elements with this name in the given root element on the first level only.

Parameters:

root - a Element object.

name - a String object.

Returns:

null if the root or name is null else the list of nodes

getLocalElements

public static NodeList getLocalElements(Element root)

Returns a list of all elements in the given root element on the first level only.

Parameters:

root - a Element object.

Returns:

null if the root is null otherwise the list of nodes

getLocalElementIterator

public static MXml.ElementIterator getLocalElementIterator(Element root,
                                                           String name)

Returns an iterator of elements with this name in the given root element on the first level only.

Parameters:

root - a Element object.

name - a String object.

Returns:

every time an iterator - never null

getLocalElementIterator

public static MXml.ElementIterator getLocalElementIterator(Element root)

Returns an iterator of all elements in the given root element on the first level only.

Parameters:

root - a Element object.

Returns:

a MXml.ElementIterator object.

getElementByPath

public static Element getElementByPath(Element root,
                                       String path)

Returns the first found element by path. Available search definitions are slash and bracked, e.g. "/root/somenode/number[3]/name"

Parameters:

root - a Element object.

path - a String object.

Returns:

null if root or path is null or the element is not found

getPathAsString

public static String getPathAsString(Node in)

Returns the path to the node as string representation, separated with slashes.

Parameters:

in - a Node object.

Returns:

an empty string if the node is null

loadXml

public static Document loadXml(String xml,
                               String charset)
                        throws ParserConfigurationException,
                               UnsupportedEncodingException,
                               SAXException,
                               IOException

Create a XML Document from a string. Using the defined charset.

Parameters:

xml - a String object.

charset - a String object.

Returns:

a Document object.

Throws:

ParserConfigurationException - if any.

UnsupportedEncodingException - if any.

SAXException - if any.

IOException - if any.

loadXml

public static Document loadXml(String xml)
                        throws ParserConfigurationException,
                               SAXException,
                               IOException

Create a XML Document from a string.

Parameters:

xml - a String object.

Returns:

a Document object.

Throws:

ParserConfigurationException - if any.

SAXException - if any.

IOException - if any.

loadXml

public static Document loadXml(InputStream is)
                        throws ParserConfigurationException,
                               SAXException,
                               IOException

Create a XML Document from a stream resource.

Parameters:

is - a InputStream object.

Returns:

a Document object.

Throws:

ParserConfigurationException - if any.

SAXException - if any.

IOException - if any.

loadXml

public static Document loadXml(Reader file)
                        throws ParserConfigurationException,
                               SAXException,
                               IOException

loadXml.

Parameters:

file - a Reader object.

Returns:

a Document object.

Throws:

ParserConfigurationException - if any.

SAXException - if any.

IOException - if any.

saveXml

public static void saveXml(Node e,
                           OutputStream out)
                    throws Exception

Write the element into the stream.

Parameters:

e - a Node object.

out - a OutputStream object.

Throws:

Exception - if any.

saveXml

public static void saveXml(Node e,
                           Writer out,
                           boolean intend)
                    throws Exception

saveXml.

Parameters:

e - a Node object.

out - a Writer object.

intend - a boolean.

Throws:

Exception - if any.

toString

public static String toString(Node e,
                              boolean intend)
                       throws Exception

toString.

Parameters:

e - a Node object.

intend - a boolean.

Returns:

a String object.

Throws:

Exception - if any.

createDocument

public static Document createDocument()
                               throws Exception

Create and return a empty xml document.

Returns:

a Document object.

Throws:

Exception - if any.

encode

public static String encode(String _in)

Encode the default problematic characters in a string to store it in a xml value.

Parameters:

_in - a String object.

Returns:

a String object.

unicodeEncode

public static String unicodeEncode(String _in)

Encodes the amp and all characters greater then 255 to unicode representation with amp and hash signs.

Parameters:

_in - a String object.

Returns:

a String object.

decode

public static String decode(String _in)

Decodes a string with encoded characters to a java string.

Parameters:

_in - a String object.

Returns:

a String object.

dump

public static String dump(Node element)

Prints information - most technical - of the xml element and its childs and returns it as string. Use this function for debugging (debugger).

Parameters:

element - a Node object.

Returns:

a String object.

dump

public static void dump(PrintStream o,
                        Node element)

Prints information - most technical - of the xml element and its childs to the stream.

Parameters:

o - a PrintStream object.

element - a Node object.

dump

public static void dump(PrintStream o,
                        Node node,
                        String level)

dump.

Parameters:

o - a PrintStream object.

node - a Node object.

level - a String object.

dump

public static void dump(PrintStream out,
                        NodeList nodes)

dump.

Parameters:

out - a PrintStream object.

nodes - a NodeList object.

innerXml

public static String innerXml(Node node)

Returns the inner XML Structure as string with all tag definitions.

Parameters:

node - a org$w3c$dom$Node object.

Returns:

a String object.

innerXml

public static String innerXml(Node node,
                              boolean instructions)

Returns the inner XML Structure as string with all tag definitions.

Parameters:

node - a org$w3c$dom$Node object.

instructions - set to false to ignore processing instructions (on the first level)

Returns:

null if the node is null otherwise the innerXml as text

queryXPath

public static MXml.NodeIterator queryXPath(Node root,
                                           String query)
                                    throws XPathExpressionException

Execute an XPATH query for a list of nodes.

Parameters:

root - a Node object.

query - a String object.

Returns:

never null

Throws:

XPathExpressionException - if any.

queryXPathElements

public static MXml.ElementIterator queryXPathElements(Node root,
                                                      String query)
                                               throws XPathExpressionException

Execute an XPATH query for a list of elements.

Parameters:

root - a Node object.

query - a String object.

Returns:

never null

Throws:

XPathExpressionException - if any.

trim

public static void trim(Element element)

Remove white spaces in the text nodes.

Parameters:

element - a Element object.

carveOut

public static void carveOut(Element element)

Remove the element from his parent but append the children instead if it into the parent node - on the same position.

Parameters:

element - a Element object.

normalizeName

public static String normalizeName(String key)

Normalize the name of attributes or node names. Allowed characters are (a-z, A-Z, 0-9, - _ .) all other characters are replaced with _

Parameters:

key - a String object.

Returns:

normalized key or null if the key is null.

removeTags

public static String removeTags(String txt)

removeTags.

Parameters:

txt - a String object.

Returns:

a String object.

removeHtmlTags

public static String removeHtmlTags(String txt)

removeHtmlTags.

Parameters:

txt - a String object.

Returns:

a String object.

getValue

public static String getValue(Element root,
                              String path,
                              String def)

getValue.

Parameters:

root - a Element object.

path - a String object.

def - a String object.

Returns:

a String object.

findCDataSection

public static CDATASection findCDataSection(Element a)

findCDataSection.

Parameters:

a - a Element object.

Returns:

a CDATASection object.

Since:

3.2.9