project35.util
Class Project35XMLParsingUtility

java.lang.Object
  extended by project35.util.Project35XMLParsingUtility

public class Project35XMLParsingUtility
extends java.lang.Object

convenience routines used to parse XML files and XML schemas


Copyright (c) Kevin Garwood and University of Manchester 2007. All rights reserved. Licensed under the Academic Free License version 3.0. For more information on the terms and conditions, please see the file "LICENSE" that is included in this distribution.

Version:
1.0
Author:
Kevin Garwood (kgarwood@users.sourceforge.net), code contributions from 2002 - September 30, 2007.

Constructor Summary
Project35XMLParsingUtility()
           
 
Method Summary
protected  java.lang.String createInlineImage(java.lang.String fieldValue)
           
static java.lang.String escapeXml(java.lang.String str)
          Convenience method for escaping XML characters in a given String.
static java.lang.String getCData(org.w3c.dom.Element element)
           
static org.w3c.dom.Element getElement(org.w3c.dom.Node node, java.lang.String tagName)
           
protected  org.w3c.dom.Element getElement(org.w3c.dom.Node node, java.lang.String tagName, java.lang.String elementName)
           
static java.lang.String getFieldValue(org.w3c.dom.Element element)
          convenience routine for extracting the text value for an element
static org.w3c.dom.Element getFirstChildElement(org.w3c.dom.Node node)
           
static org.w3c.dom.Element getNextSiblingElement(org.w3c.dom.Element element)
           
static Parameter[] getParameters(org.w3c.dom.Element parametersElement)
          this method assumes that all tag children of parameters element can be bundled into name value pairs (see class project35.util.Parameter)
static java.lang.String getValue(org.w3c.dom.Element element)
           
 boolean interpretBooleanValue(java.lang.String value)
           
 int interpretIntegerValue(java.lang.String value)
           
protected static boolean isRequired(java.lang.String minOccurs)
           
protected static boolean isRequiredOrOptional(java.lang.String minOccurs)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Project35XMLParsingUtility

public Project35XMLParsingUtility()
Method Detail

escapeXml

public static java.lang.String escapeXml(java.lang.String str)
Convenience method for escaping XML characters in a given String. It translates: The method does not throw a NullPointerException if the given String is null. Instead, it returns a null.

Parameters:
str - The string to be escaped.
Returns:
the string with all XML characters escaped.

isRequired

protected static boolean isRequired(java.lang.String minOccurs)

isRequiredOrOptional

protected static boolean isRequiredOrOptional(java.lang.String minOccurs)

getNextSiblingElement

public static org.w3c.dom.Element getNextSiblingElement(org.w3c.dom.Element element)

getFieldValue

public static java.lang.String getFieldValue(org.w3c.dom.Element element)
convenience routine for extracting the text value for an element


getFirstChildElement

public static org.w3c.dom.Element getFirstChildElement(org.w3c.dom.Node node)

getParameters

public static Parameter[] getParameters(org.w3c.dom.Element parametersElement)
this method assumes that all tag children of parameters element can be bundled into name value pairs (see class project35.util.Parameter)


getCData

public static java.lang.String getCData(org.w3c.dom.Element element)

getElement

public static org.w3c.dom.Element getElement(org.w3c.dom.Node node,
                                             java.lang.String tagName)

getElement

protected org.w3c.dom.Element getElement(org.w3c.dom.Node node,
                                         java.lang.String tagName,
                                         java.lang.String elementName)

getValue

public static java.lang.String getValue(org.w3c.dom.Element element)

interpretIntegerValue

public int interpretIntegerValue(java.lang.String value)
                          throws java.lang.Exception
Throws:
java.lang.Exception

interpretBooleanValue

public boolean interpretBooleanValue(java.lang.String value)

createInlineImage

protected java.lang.String createInlineImage(java.lang.String fieldValue)