uk.ac.ed.epcc.safe.accounting.ogf.ur

Class XMLSplitter

java.lang.Object

uk.ac.ed.epcc.safe.accounting.ogf.ur.XMLSplitter

All Implemented Interfaces:

org.xml.sax.ContentHandler

public class XMLSplitter
extends java.lang.Object
implements org.xml.sax.ContentHandler

This content handler expects a single OGF UsageRecords XML element as specified by the OGF Usage Record specification. The XML format of this element can be found in the OGF specification.

This content handler is slightly more liberal than the specification requires. The specification states that multiple UsageRecord elements should be contained in a single UsageRecords element. This parser does not enforce that restriction. In fact, this parser ignores anything outside of a UsageRecord element. Each element returned by this parser's iterator is simply all text in a UsageRecord element including the start and end <UsageRecord> tags. If any namespaces were declared in the parents of a UsageRecord element, they are added to the UsageRecord element's opening tag. As a result, each element returned by the iterator should be a valid XML document in itself, although it will be missing the optional XML header (the <?xml version="1.0" encoding="UTF-8"?> bit)

Author:

jgreen4

Constructor Summary

Constructors

Constructor and Description
XMLSplitter() Constructs a new XMLSplitter.
XMLSplitter(java.lang.String[] targets)

Method Summary

Methods

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length)
void	endDocument()
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String name)
void	endPrefixMapping(java.lang.String prefix)
void	ignorableWhitespace(char[] ch, int start, int length) Not used
java.util.Iterator<java.lang.String>	iterator()
void	processingInstruction(java.lang.String target, java.lang.String data) Not used
void	setDocumentLocator(org.xml.sax.Locator locator) Not used
void	skippedEntity(java.lang.String name) Not used
void	startDocument()
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String name, org.xml.sax.Attributes atts)
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri)

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLSplitter

public XMLSplitter()

Constructs a new XMLSplitter.

XMLSplitter

public XMLSplitter(java.lang.String[] targets)

Method Detail

iterator

public java.util.Iterator<java.lang.String> iterator()

Returns:

An iterator that will iterate over all the usage records this content handler obtained by splitting the contents it parsed. This iterator may be fetched before parsing but it will not return any elements until after parsing.

startDocument

public void startDocument()
                   throws java.lang.IllegalStateException

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Throws:

java.lang.IllegalStateException

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

characters

public void characters(char[] ch,
              int start,
              int length)

Specified by:

characters in interface org.xml.sax.ContentHandler

endElement

public void endElement(java.lang.String uri,
              java.lang.String localName,
              java.lang.String name)

Specified by:

endElement in interface org.xml.sax.ContentHandler

startElement

public void startElement(java.lang.String uri,
                java.lang.String localName,
                java.lang.String name,
                org.xml.sax.Attributes atts)

Specified by:

startElement in interface org.xml.sax.ContentHandler

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                      java.lang.String uri)

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                       int start,
                       int length)

Not used

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

processingInstruction

public void processingInstruction(java.lang.String target,
                         java.lang.String data)

Not used

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

skippedEntity

public void skippedEntity(java.lang.String name)

Not used

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)

Not used

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler