org.codice.ddf.transformer.xml.streaming.lib

Class SaxEventToXmlElementConverter

java.lang.Object

org.codice.ddf.transformer.xml.streaming.lib.SaxEventToXmlElementConverter

public class SaxEventToXmlElementConverter
extends Object

A library class used to turn SAX events back into their corresponding XML snippets

Not threadsafe

Constructor Summary

Constructors

Constructor and Description
SaxEventToXmlElementConverter()

Method Summary

Modifier and Type	Method and Description
void	addNamespace(String prefix, String uri) Method used in a SaxEventHandler#startElement(String, String, String, Attributes) to populate the SaxEventToXmlElementConverter#namespaceMapping, which allows namespaceURI/prefix lookup.
void	removeNamespace(String prefix)
SaxEventToXmlElementConverter	reset() Resets all stateful variables of the SaxEventToXmlElementConverter Should be used before expecting a fresh XML snippet Can be used instead of declaring a new one
SaxEventToXmlElementConverter	toElement(char[] ch, int start, int length) Method used to reconstruct the characters/value of an XML element.
SaxEventToXmlElementConverter	toElement(String uri, String localName) Method used to reconstruct the end tag of an XML element.
SaxEventToXmlElementConverter	toElement(String uri, String localName, Attributes atts) Used to reconstruct the start tag of an XML element.
String	toString() Overridden toString method to return the XML snippet that has been reconstructed

Methods inherited from class java.lang.Object

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

Constructor Detail

SaxEventToXmlElementConverter

public SaxEventToXmlElementConverter()
                              throws UnsupportedEncodingException,
                                     XMLStreamException

Throws:

UnsupportedEncodingException

XMLStreamException

Method Detail

toElement

public SaxEventToXmlElementConverter toElement(String uri,
                                               String localName,
                                               Attributes atts)
                                        throws XMLStreamException

Used to reconstruct the start tag of an XML element.

Parameters:

uri - the URI that is passed in by SaxEventHandler

localName - the localName that is passed in by SaxEventHandler

atts - the attributes that are passed in by SaxEventHandler

Returns:

this SaxEventHandler#startElement

Throws:

XMLStreamException

toElement

public SaxEventToXmlElementConverter toElement(String uri,
                                               String localName)
                                        throws XMLStreamException

Method used to reconstruct the end tag of an XML element.

Parameters:

uri - the namespaceURI that is passed in by SaxEventHandler

localName - the localName that is passed in by SaxEventHandler

Returns:

this SaxEventHandler#endElement

Throws:

XMLStreamException

toElement

public SaxEventToXmlElementConverter toElement(char[] ch,
                                               int start,
                                               int length)
                                        throws XMLStreamException

Method used to reconstruct the characters/value of an XML element.

Parameters:

ch - the ch that is passed in by SaxEventHandler

start - the start that is passed in by SaxEventHandler

length - the length that is passed in by SaxEventHandler

Returns:

this SaxEventHandler#characters

Throws:

XMLStreamException

toString

public String toString()

Overridden toString method to return the XML snippet that has been reconstructed

Overrides:

toString in class Object

Returns:

the reconstructed XML snippet

reset

public SaxEventToXmlElementConverter reset()

Resets all stateful variables of the SaxEventToXmlElementConverter Should be used before expecting a fresh XML snippet Can be used instead of declaring a new one

Returns:

this

addNamespace

public void addNamespace(String prefix,
                         String uri)
                  throws XMLStreamException

Method used in a SaxEventHandler#startElement(String, String, String, Attributes) to populate the SaxEventToXmlElementConverter#namespaceMapping, which allows namespaceURI/prefix lookup. (Could potentially be used elsewhere, but one would have to ensure correct use)

Parameters:

prefix - the namespace prefix that is passed in by SaxEventHandler

uri - the namespace uri that is passed in by SaxEventHandler

Throws:

XMLStreamException

removeNamespace

public void removeNamespace(String prefix)