org.biojavax.utils
Class XMLTools

java.lang.Object
  org.biojavax.utils.XMLTools

public class XMLTools
extends java.lang.Object

Utility class for reading chunks of XML files and feeding them to SAX.

Since:

1.5

Author:

Richard Holland

Method Summary

static boolean

readXMLChunk(java.io.BufferedReader reader, org.xml.sax.helpers.DefaultHandler m_handler, java.lang.String chunkToken) Attempts to read XML file in chunks, passing each chunk to a SAX parser.

Methods inherited from class java.lang.Object

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

Method Detail

readXMLChunk

public static boolean readXMLChunk(java.io.BufferedReader reader,
                                   org.xml.sax.helpers.DefaultHandler m_handler,
                                   java.lang.String chunkToken)
                            throws javax.xml.parsers.ParserConfigurationException,
                                   org.xml.sax.SAXException,
                                   java.io.IOException

Attempts to read XML file in chunks, passing each chunk to a SAX parser. As each chunk is read into memory in a buffer, you need to ensure that each chunk is small enough to fit into available memory. Only one chunk is held in memory at any one time, and then only long enough for it to be parsed. When checking for the presence of further chunks, it'll only read up to 1000 chars further into the file, after which results will be unpredictable.

Parameters:

reader - the reader to read the XML from

m_handler - the SAX parser to feed the XML to

chunkToken - the token to read. The parser will locate the first instance of <chunkToken and will buffer all content, including the opening tag and up to and including the closing </chunkToken> tag. It will not currently handle <chunkToken/> instances, nor instances where more than one tag appears per line, or extra spaces appear between the angle brackets, slashes, and tag name of the tag we are searching for.

Returns:

true if there is another chunk left to read after this one, false if not.

Throws:

javax.xml.parsers.ParserConfigurationException - if there was a problem setting up the SAX parser.

org.xml.sax.SAXException - if there was a problem parsing the XML.

java.io.IOException - if there was a problem reading the XML from the reader.