com.viaoa.util

Class OAXMLReader1

java.lang.Object

org.xml.sax.helpers.DefaultHandler

com.viaoa.util.OAXMLReader1

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class OAXMLReader1
extends DefaultHandler

OAXMLReader using a SAXParser to parse and automatically create OAObjects from a XML file. This will do the following to find the existing object: 1: if OAProperty.importMatch, then it will search to find a matching object 2: if objectId props, then it will search to find a matching object 3: use guid if not found, then a new object will be created.

See Also:

OAXMLWriter

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	bUseRef
protected Class	conversionClass
protected Object	firstObject
protected HashMap	hashGuid
protected HashMap<Class,HashMap<OAObjectKey,OAObject>>	hmMatch
protected Object	refValue
protected Vector	vecIncomplete
protected Vector	vecRemoved
protected Vector	vecRoot

Constructor Summary

Constructors

Constructor and Description
OAXMLReader1()
OAXMLReader1(String fileName)

Method Summary

Modifier and Type	Method and Description
void	characters(char[] buf, int offset, int len) SAXParser callback method.
Object	convertToObject(String propertyName, String value, Class propertyClass) Convert from String to correct type.
OAObject	createNewObject(Class c) Method that can be overwritten by subclass to create a new Object for a specific Class.
void	endDocument() SAXParser callback method.
void	endElement(String namespaceURI, String sName, String qName) SAXParser callback method.
void	endObject(OAObject obj, boolean hasParent) Method that can be overwritten by subclass when an object is completed.
String	getDecodeMessage()
String	getFileName()
boolean	getImportMatching()
protected String	getPropertyName(OAObject obj, String propName)
protected Object	getRealObject(OAObject object) By default, this will check to see if object already exists in OAObjectCache and return that object.
Object[]	getRootObjects() Returns all root objects from last call to parse.
Object	getValue(OAObject obj, String name, Object value) Method that can be used to replace the value of an element/attribute.
Object	parse() Used to parse and create OAObjects from an XML file.
Object	parse(String fileName) Used to parse and create OAObjects from an XML file.
Object	parseString(String xmlData) Used to parse and create OAObjects from an XML string.
protected boolean	processProperties(OAObject object, Hashtable hash)
protected void	processProperty(String eName, String value, Class conversionClass, Hashtable hash)
Object	read() Used to parse and create OAObjects from an XML file.
Object	read(String fileName) Used to parse and create OAObjects from an XML file.
protected void	reset()
protected String	resolveClassName(String className)
void	setDecodeMessage(String msg) Used to unencrypt an XML file created by OAXMLWriter that used an encryption code.
void	setFileName(String fileName)
void	setImportMatching(boolean b)
void	startDocument() SAXParser callback method.
void	startElement(String namespaceURI, String sName, String qName, Attributes attrs) SAXParser callback method.
void	startHub(String className, int total) Method that can be overwritten by subclass to provide status of reader.

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

bUseRef

protected boolean bUseRef

refValue

protected Object refValue

firstObject

protected Object firstObject

conversionClass

protected Class conversionClass

vecIncomplete

protected Vector vecIncomplete

vecRoot

protected Vector vecRoot

hashGuid

protected HashMap hashGuid

hmMatch

protected HashMap<Class,HashMap<OAObjectKey,OAObject>> hmMatch

vecRemoved

protected Vector vecRemoved

Constructor Detail

OAXMLReader1

public OAXMLReader1()

OAXMLReader1

public OAXMLReader1(String fileName)

Method Detail

setFileName

public void setFileName(String fileName)

getFileName

public String getFileName()

setImportMatching

public void setImportMatching(boolean b)

getImportMatching

public boolean getImportMatching()

read

public Object read(String fileName)
            throws Exception

Used to parse and create OAObjects from an XML file.

Returns:

topmost object from XML file.

Throws:

Exception

read

public Object read()
            throws Exception

Used to parse and create OAObjects from an XML file.

Returns:

topmost object from XML file.

Throws:

Exception

parse

public Object parse()
             throws Exception

Used to parse and create OAObjects from an XML file.

Returns:

topmost object from XML file.

Throws:

Exception

reset

protected void reset()

parse

public Object parse(String fileName)
             throws Exception

Used to parse and create OAObjects from an XML file.

Returns:

topmost object from XML file.

Throws:

Exception

parseString

public Object parseString(String xmlData)
                   throws Exception

Used to parse and create OAObjects from an XML string.

Returns:

topmost object from XML file.

Throws:

Exception

getRootObjects

public Object[] getRootObjects()

Returns all root objects from last call to parse.

setDecodeMessage

public void setDecodeMessage(String msg)

Used to unencrypt an XML file created by OAXMLWriter that used an encryption code.

See Also:

OAXMLWriter.setEncodeMessage(String)

getDecodeMessage

public String getDecodeMessage()

startElement

public void startElement(String namespaceURI,
                         String sName,
                         String qName,
                         Attributes attrs)
                  throws SAXException

SAXParser callback method.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

endElement

public void endElement(String namespaceURI,
                       String sName,
                       String qName)
                throws SAXException

SAXParser callback method.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

processProperty

protected void processProperty(String eName,
                               String value,
                               Class conversionClass,
                               Hashtable hash)

getPropertyName

protected String getPropertyName(OAObject obj,
                                 String propName)

processProperties

protected boolean processProperties(OAObject object,
                                    Hashtable hash)

characters

public void characters(char[] buf,
                       int offset,
                       int len)
                throws SAXException

SAXParser callback method.

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

getValue

public Object getValue(OAObject obj,
                       String name,
                       Object value)

Method that can be used to replace the value of an element/attribute.

startHub

public void startHub(String className,
                     int total)

Method that can be overwritten by subclass to provide status of reader.

endObject

public void endObject(OAObject obj,
                      boolean hasParent)

Method that can be overwritten by subclass when an object is completed.

startDocument

public void startDocument()
                   throws SAXException

SAXParser callback method.

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class DefaultHandler

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

SAXParser callback method.

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class DefaultHandler

Throws:

SAXException

createNewObject

public OAObject createNewObject(Class c)
                         throws Exception

Method that can be overwritten by subclass to create a new Object for a specific Class.

Throws:

Exception

convertToObject

public Object convertToObject(String propertyName,
                              String value,
                              Class propertyClass)

Convert from String to correct type. param clazz type of object to convert value to

Returns:

null to skip property.

getRealObject

protected Object getRealObject(OAObject object)

By default, this will check to see if object already exists in OAObjectCache and return that object. Otherwise this object is returned.

resolveClassName

protected String resolveClassName(String className)