org.qbroker.common

Class XML2Map

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.qbroker.common.XML2Map

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class XML2Map
extends org.xml.sax.helpers.DefaultHandler

XML2Map parses an XML file and maps the structural content of the XML into Java objects stored in a Map. It only recognizes three basic Java objects, String, List and Map. A Map or a List can contain any objects of the three types. They are the nodes of the data tree. A String is only a leaf in the data tree. With these three basic types of objects, any data structures will be representable. The mapping is one-to-one. Therefore, the mapping is bidirectional.

It recognizes the only attribute: type. The type defines the storage type of the data object, either scalar in default or vector. Its value of "ARRAY" for an element of an List, "NULL" for a null scalar and "NULL_ARRAY" for a null element of an List.

Author:

yannanlu@yahoo.com

Field Summary

Fields

Modifier and Type	Field and Description
static int	XML_ARRAY
static int	XML_DEFAULT
static int	XML_NULL

Constructor Summary

Constructors

Constructor and Description
XML2Map(java.lang.String parser)

Method Summary

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length)
static boolean	containsKey(java.util.Map ph, java.lang.String keyPath) returns true if the keyPath exists or false otherwise
static int	count(java.util.Map ph, java.lang.String keyPath) returns the number of children referenced by the keyPath or -1
void	endDocument()
void	endElement(java.lang.String uri, java.lang.String name, java.lang.String qName)
static java.lang.Object	get(java.util.Map ph, java.lang.String keyPath) returns the object referenced by the keyPath or null
java.util.Map	getMap(java.io.InputStream in)
java.util.Map	getMap(java.io.Reader in)
java.util.Map	getMap(java.lang.String url)
static void	main(java.lang.String[] args)
void	startDocument()
void	startElement(java.lang.String uri, java.lang.String name, java.lang.String qName, org.xml.sax.Attributes atts)

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Field Detail

XML_DEFAULT

public static final int XML_DEFAULT

See Also:

Constant Field Values

XML_ARRAY

public static final int XML_ARRAY

See Also:

Constant Field Values

XML_NULL

public static final int XML_NULL

See Also:

Constant Field Values

Constructor Detail

XML2Map

public XML2Map(java.lang.String parser)
        throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

Method Detail

getMap

public java.util.Map getMap(java.io.Reader in)
                     throws java.io.IOException,
                            org.xml.sax.SAXException

Throws:

java.io.IOException

org.xml.sax.SAXException

getMap

public java.util.Map getMap(java.io.InputStream in)
                     throws java.io.IOException,
                            org.xml.sax.SAXException

Throws:

java.io.IOException

org.xml.sax.SAXException

getMap

public java.util.Map getMap(java.lang.String url)
                     throws java.io.IOException,
                            org.xml.sax.SAXException

Throws:

java.io.IOException

org.xml.sax.SAXException

containsKey

public static boolean containsKey(java.util.Map ph,
                                  java.lang.String keyPath)

returns true if the keyPath exists or false otherwise

count

public static int count(java.util.Map ph,
                        java.lang.String keyPath)

returns the number of children referenced by the keyPath or -1

get

public static java.lang.Object get(java.util.Map ph,
                                   java.lang.String keyPath)

returns the object referenced by the keyPath or null

startDocument

public void startDocument()

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Overrides:

startDocument in class org.xml.sax.helpers.DefaultHandler

endDocument

public void endDocument()

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class org.xml.sax.helpers.DefaultHandler

startElement

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

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

endElement

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

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

characters

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

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception