alma.acs.util

Class XmlNormalizer

java.lang.Object

alma.acs.util.XmlNormalizer

public class XmlNormalizer
extends java.lang.Object

Normalizes XML data by escaping special characters such as '&' or ' <'.

Author:

hsommer created Jul 25, 2003 10:14:34 AM

Constructor Summary

Constructors

Constructor and Description
XmlNormalizer()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	normalize(java.lang.String s) Normalizes a string to not conflict with XML markup characters.
static java.lang.String	normalizeXMLEmbeddedTextOnly(java.lang.String xmlString) Normalizes any text in between quotes ("text") or text given as character data of mixed-content elements, all inside xmlString.
static java.lang.String	translate(char ch) Translates the given character ch to its masked XML representation if this character is one of { <, >, &, ", ' }.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlNormalizer

public XmlNormalizer()

Method Detail

normalize

public static java.lang.String normalize(java.lang.String s)

Normalizes a string to not conflict with XML markup characters. Only allocates memory if the string s does contain such markup. Otherwise s is returned.

normalizeXMLEmbeddedTextOnly

public static java.lang.String normalizeXMLEmbeddedTextOnly(java.lang.String xmlString)

Normalizes any text in between quotes ("text") or text given as character data of mixed-content elements, all inside xmlString. Other text is left untouched. This method can be used to fix illegal text in an unparsable XML document, without destroying the XML markup itself.

Note that some rather simple parsing is used, and that there may be cases in which the result is undesirable. Thus this method should only be used as a fallback solution when the XML string can not be parsed with a regular XML parser.

Parameters:

xmlString -

Returns:

translate

public static java.lang.String translate(char ch)

Translates the given character ch to its masked XML representation if this character is one of { <, >, &, ", ' }. Otherwise returns null.

Parameters:

ch -

Returns:

The corresponding XML representation such as "&lt;" for a '<'.