org.crosswire.common.xml
Class XMLUtil

java.lang.Object
  org.crosswire.common.xml.XMLUtil

public class XMLUtil
extends Object

Utilities for working with SAX XML parsing.

Distribution Licence:
JSword is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2 as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
The License is available on the internet here, or by writing to: Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
The copyright to this program is held by it's authors.

Version:

$Id: XMLUtil.java,v 1.9 2005/03/12 21:15:55 dmsmith Exp $

Author:

Joe Walker [joe at eireneh dot com]

See Also:

Licence

Field Summary

protected static Logger

log The log stream

Constructor Summary

private

XMLUtil() Prevent Instansiation

Method Summary

static String	cleanAllEntities(String broken) A parse has failed so we can try to kill the broken entities and then have another go.
static String	cleanAllTags(String broken) XML parse failed, so we can try getting rid of all the tags and having another go.
static void	debugSAXAttributes(Attributes attrs) Show the attributes of an element as debug
static String	escape(String s) Normalizes the given string
static org.jdom.Document	getDocument(String subject) Get and load an XML file from the classpath and a few other places into a JDOM Document object.
private static String	guessEntity(String broken) Attempt to guess what the entity should have been and fix it, or remove it if there are no obvious replacements.
static String	writeToString(SAXEventProvider provider) Serialize a SAXEventProvider into an XML String

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final Logger log

The log stream

Constructor Detail

XMLUtil

private XMLUtil()

Prevent Instansiation

Method Detail

getDocument

public static org.jdom.Document getDocument(String subject)
                                     throws org.jdom.JDOMException,
                                            IOException

Get and load an XML file from the classpath and a few other places into a JDOM Document object.

Parameters:

subject - The name of the desired resource (without any extension)

Returns:

The requested resource

Throws:

IOException - if there is a problem reading the file

org.jdom.JDOMException - If the resource is not valid XML

writeToString

public static String writeToString(SAXEventProvider provider)
                            throws SAXException

Serialize a SAXEventProvider into an XML String

Parameters:

provider - The source of SAX events

Returns:

a serialized string

Throws:

SAXException

debugSAXAttributes

public static void debugSAXAttributes(Attributes attrs)

Show the attributes of an element as debug

escape

public static String escape(String s)

Normalizes the given string

cleanAllEntities

public static String cleanAllEntities(String broken)

A parse has failed so we can try to kill the broken entities and then have another go.

guessEntity

private static String guessEntity(String broken)

Attempt to guess what the entity should have been and fix it, or remove it if there are no obvious replacements.

cleanAllTags

public static String cleanAllTags(String broken)

XML parse failed, so we can try getting rid of all the tags and having another go. We define a tag to start at a < and end at the end of the next word (where a word is what comes in between spaces) that does not contain an = sign, or at a >, whichever is earlier.