org.licas_xml.model

Class XmlHandler

java.lang.Object

org.licas_xml.model.XmlHandler

public class XmlHandler
extends java.lang.Object

This class can be used to parse XML to or from a String in formatted or un-formatted form.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CODER
static java.lang.String	END_LT_TAG
static java.lang.String	GT
static java.lang.String	GT_TAG The XML tags and the characters that replace them during conversion
static java.lang.String	LT
static java.lang.String	LT_TAG
static java.lang.String	SEPARATOR
protected static java.lang.String	XMLELEMENT
protected static java.lang.String	XMLELEMENTINTERFACE Defines an element
static java.lang.String	XMLHEADEND
static java.lang.String	XMLHEADSTART

Constructor Summary

Constructors

Constructor and Description
XmlHandler() Create a new instance of XmlHandler

Method Summary

Modifier and Type	Method and Description
static java.lang.String	addElementSpec(java.lang.String xmlStr) Add the special characters indicating an XML element.
static java.lang.String	addPrefix(java.lang.String prefix, java.lang.String tag) Add the prefix to the element tag name.
static java.lang.String	addStringSpec(java.lang.String xmlStr) Add the special characters indicating a string of any format that should not be converted into anything else.
static Element	elementFromStream(java.io.FileInputStream inputStream) Create an element representing the data in the input stream.
static boolean	elementsMatch(java.lang.String className1, java.lang.String className2) Return true if the two class names represent elements supported by the current XML parser.
static Element	firstWithName(Element rootElem, java.lang.String elemName) Get the first element with the specified name.
static java.lang.String	getPrefix(java.lang.String valueStr) Get the prefix to the value passed in if one exists.
static boolean	isElement(java.lang.String className) Return true if the class name indicates an XML element.
static boolean	isElementSpec(java.lang.String xmlStr) Return true if the String is an element specification.
static boolean	isStringCoder(java.lang.String xmlStr) Return true if the input is actually the string coder.
static java.util.Vector<java.lang.String>	listToVector(Element xmlList) Convert the list in XML format into a Vector.
static java.lang.String	removeCoding(java.lang.String xmlStr) Remove the special text sequences added as coding.
static java.lang.String	removeElementSpecs(java.lang.String xmlStr) Remove the text sequences indicating an XML element.
static java.lang.String	removePrefix(java.lang.String valueStr) Get the tag value with the prefix removed if one exists.
static java.lang.String	removeStringSpec(java.lang.String xmlStr) Remove the special text characters indicating the string that should not be converted into XML.
static java.lang.String	removeStringSpecs(java.lang.String xmlStr) Remove the special text coding sequences anywhere in the string.
static Element	stringToElement(java.lang.String elemStr) Convert the string representation back to an element.
static Element	wrapWithElement(java.lang.String tag, java.lang.String meta) Wrap the input string with an element.
static void	xmlToFile(java.io.FileOutputStream outputStream, Document document) Convert an XML document into its String equivalent and write to the file.
static java.lang.String	xmlToFormattedString(Element rootElem) Convert an XML document into a formatted String equivalent.
static java.lang.String	xmlToString(Document document) Convert an XML document into its String equivalent.
static java.lang.String	xmlToString(Element element) Convert an XML element into its String equivalent.

Methods inherited from class java.lang.Object

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

Field Detail

GT_TAG

public static final java.lang.String GT_TAG

The XML tags and the characters that replace them during conversion

See Also:

Constant Field Values

GT

public static final java.lang.String GT

See Also:

Constant Field Values

LT_TAG

public static final java.lang.String LT_TAG

See Also:

Constant Field Values

END_LT_TAG

public static final java.lang.String END_LT_TAG

See Also:

Constant Field Values

LT

public static final java.lang.String LT

See Also:

Constant Field Values

XMLHEADSTART

public static final java.lang.String XMLHEADSTART

See Also:

Constant Field Values

XMLHEADEND

public static final java.lang.String XMLHEADEND

See Also:

Constant Field Values

XMLELEMENTINTERFACE

protected static final java.lang.String XMLELEMENTINTERFACE

Defines an element

XMLELEMENT

protected static final java.lang.String XMLELEMENT

SEPARATOR

public static final java.lang.String SEPARATOR

See Also:

Constant Field Values

CODER

public static final java.lang.String CODER

See Also:

Constant Field Values

Constructor Detail

XmlHandler

public XmlHandler()

Create a new instance of XmlHandler

Method Detail

xmlToString

public static java.lang.String xmlToString(Document document)
                                    throws java.lang.Exception

Convert an XML document into its String equivalent.

Parameters:

document - the document.

Returns:

the contents in String format.

Throws:

java.lang.Exception - any error.

xmlToString

public static java.lang.String xmlToString(Element element)
                                    throws java.lang.Exception

Convert an XML element into its String equivalent.

Parameters:

element - the element.

Returns:

the contents in String format.

Throws:

java.lang.Exception - any error.

xmlToFormattedString

public static java.lang.String xmlToFormattedString(Element rootElem)
                                             throws java.lang.Exception

Convert an XML document into a formatted String equivalent.

Parameters:

rootElem - the root element.

Returns:

the contents in String format.

Throws:

java.lang.Exception - any error.

xmlToFile

public static void xmlToFile(java.io.FileOutputStream outputStream,
                             Document document)
                      throws java.lang.Exception

Convert an XML document into its String equivalent and write to the file.

Parameters:

outputStream - the file to write to.

document - the document.

Throws:

java.lang.Exception - any error.

stringToElement

public static Element stringToElement(java.lang.String elemStr)
                               throws java.lang.Exception

Convert the string representation back to an element.

Parameters:

elemStr - the element as a string.

Returns:

the re-constructed element.

Throws:

java.lang.Exception - any error.

elementFromStream

public static Element elementFromStream(java.io.FileInputStream inputStream)
                                 throws java.lang.Exception

Create an element representing the data in the input stream.

Parameters:

inputStream - the input stream in XML format.

Returns:

the XML as an element.

Throws:

java.lang.Exception - any error.

listToVector

public static java.util.Vector<java.lang.String> listToVector(Element xmlList)

Convert the list in XML format into a Vector.

Parameters:

xmlList - the list in XML format.

Returns:

the list as a Vector.

wrapWithElement

public static Element wrapWithElement(java.lang.String tag,
                                      java.lang.String meta)

Wrap the input string with an element.

Parameters:

tag - the element tag.

meta - the string value.

Returns:

an xml element.

firstWithName

public static Element firstWithName(Element rootElem,
                                    java.lang.String elemName)
                             throws java.lang.Exception

Get the first element with the specified name.

Parameters:

rootElem - the root element to parse from.

elemName - the name of the element to find.

Returns:

the first (depth-first) element that matches with the element name, or null if none exist.

Throws:

java.lang.Exception - any error.

addPrefix

public static java.lang.String addPrefix(java.lang.String prefix,
                                         java.lang.String tag)

Add the prefix to the element tag name.

Parameters:

prefix - the prefix name.

tag - the tag name.

Returns:

the new tag name with the prefix added.

getPrefix

public static java.lang.String getPrefix(java.lang.String valueStr)

Get the prefix to the value passed in if one exists.

Parameters:

valueStr - the value to parse to retrieve the prefix.

Returns:

the prefix value or null if one does not exist.

removePrefix

public static java.lang.String removePrefix(java.lang.String valueStr)

Get the tag value with the prefix removed if one exists.

Parameters:

valueStr - the value to parse to remove the prefix.

Returns:

the value without any prefix.

elementsMatch

public static boolean elementsMatch(java.lang.String className1,
                                    java.lang.String className2)

Return true if the two class names represent elements supported by the current XML parser.

Parameters:

className1 - the class name of the first object.

className2 - the class name of the second object.

Returns:

true if these two objects match and represent XML elements.

isElement

public static boolean isElement(java.lang.String className)

Return true if the class name indicates an XML element.

Parameters:

className - the class name of the object.

Returns:

true if an XML element as used by the parsers.

isElementSpec

public static boolean isElementSpec(java.lang.String xmlStr)

Return true if the String is an element specification.

Parameters:

xmlStr - the xml String. This should start with the element class and the special additional characters.

Returns:

true if the string starts with the xml element spec characters.

isStringCoder

public static boolean isStringCoder(java.lang.String xmlStr)

Return true if the input is actually the string coder. This can happen when XML gets parsed sometimes - the coder is separated as a new element.

Parameters:

xmlStr - the original String.

Returns:

true if the text contents is the string coder text.

addStringSpec

public static java.lang.String addStringSpec(java.lang.String xmlStr)

Add the special characters indicating a string of any format that should not be converted into anything else. The Parsers however will automatically try to remove this coding as part of a final parsing event.

Parameters:

xmlStr - the original String.

Returns:

the String with the special characters included.

removeStringSpec

public static java.lang.String removeStringSpec(java.lang.String xmlStr)

Remove the special text characters indicating the string that should not be converted into XML. This is at the start of the string only.

Parameters:

xmlStr - the original String with the special characters included.

Returns:

the String with the special characters removed.

removeStringSpecs

public static java.lang.String removeStringSpecs(java.lang.String xmlStr)

Remove the special text coding sequences anywhere in the string.

Parameters:

xmlStr - the original String with the special characters included.

Returns:

the String with the special characters removed.

addElementSpec

public static java.lang.String addElementSpec(java.lang.String xmlStr)

Add the special characters indicating an XML element.

Parameters:

xmlStr - the original String.

Returns:

the String with the special characters included.

removeElementSpecs

public static java.lang.String removeElementSpecs(java.lang.String xmlStr)

Remove the text sequences indicating an XML element.

Parameters:

xmlStr - the original String with the special characters included.

Returns:

the String with the special characters removed.

removeCoding

public static java.lang.String removeCoding(java.lang.String xmlStr)

Remove the special text sequences added as coding. This is anywhere in the string. This calls both removeElementSpecs and removeStringSpecs for a complete clean.

Parameters:

xmlStr - the original String with the special characters included.

Returns:

the String with the special characters removed.