com.viaoa.util

Class OAXMLReader

java.lang.Object

com.viaoa.util.OAXMLReader

public class OAXMLReader
extends Object

OAXMLReader using a SAXParser to parse and automatically create OAObjects from an 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	bWithinTag
protected Class	conversionClass
boolean	debug
protected HashMap<String,OAObject>	hashGuid
protected int	indent
protected Object[]	stack
protected int	total
protected String	value

Constructor Summary

Constructors

Constructor and Description
OAXMLReader()

Method Summary

Modifier and Type	Method and Description
protected ArrayList<Object>	_process()
protected OAObject	_processChildren(HashMap<String,Object> hm, Class<? extends OAObject> toClass, boolean bIsPreloading, int level)
protected Object	_processRoot(String key, HashMap<String,Object> hm, boolean bIsPreloading)
protected void	afterLoadObject(OAObject obj, HashMap<String,Object> hm)
protected void	beforeLoadObject(OAObject obj, HashMap<String,Object> hm)
protected void	characters(char[] buf, int offset, int len)
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.
protected void	endDocument()
protected void	endElement(String namespaceURI, String sName, String qName)
protected void	endObject(OAObject obj, boolean hasParent) Method that can be overwritten by subclass when an object is completed.
String	getDecodeMessage()
protected DefaultHandler	getDefaultHandler()
boolean	getImportMatching()
protected OAObject	getObject(Class toClass, HashMap<String,Object> hm) Called before creating and loading a new object.
protected String	getPropertyName(OAObject obj, String propName)
protected OAObject	getRealObject(OAObject object)
Object	getValue(OAObject obj, String name, Object value) Method that can be used to replace the value of an element/attribute.
static void	main(String[] args)
protected void	parseFile(String fileName)
protected void	parseString(String xmlData)
protected ArrayList	process()
Object[]	read(File file)
Object[]	readFile(String fileName) Read the xml data from a file and load into objects.
Object[]	readXML(String xmlText) Read the xml data and load into objects.
protected void	reset()
protected String	resolveClassName(String className) This can be overwritten to change/expand a class name
void	setDecodeMessage(String msg) Used to unencrypt an XML file created by OAXMLWriter that used an encryption code.
void	setImportMatching(boolean b)
protected void	startDocument()
protected void	startElement(String namespaceURI, String sName, String qName, Attributes attrs)

Methods inherited from class java.lang.Object

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

Field Detail

value

protected String value

indent

protected int indent

total

protected int total

bWithinTag

protected boolean bWithinTag

stack

protected Object[] stack

conversionClass

protected Class conversionClass

hashGuid

protected HashMap<String,OAObject> hashGuid

debug

public boolean debug

Constructor Detail

OAXMLReader

public OAXMLReader()

Method Detail

readFile

public Object[] readFile(String fileName)
                  throws Exception

Read the xml data from a file and load into objects.

Throws:

Exception

read

public Object[] read(File file)
              throws Exception

Throws:

Exception

readXML

public Object[] readXML(String xmlText)
                 throws Exception

Read the xml data and load into objects.

Throws:

Exception

setImportMatching

public void setImportMatching(boolean b)

getImportMatching

public boolean getImportMatching()

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()

reset

protected void reset()

parseFile

protected void parseFile(String fileName)
                  throws Exception

Throws:

Exception

parseString

protected void parseString(String xmlData)
                    throws Exception

Throws:

Exception

process

protected ArrayList process()
                     throws Exception

Throws:

Exception

_process

protected ArrayList<Object> _process()
                              throws Exception

Throws:

Exception

_processRoot

protected Object _processRoot(String key,
                              HashMap<String,Object> hm,
                              boolean bIsPreloading)
                       throws Exception

Throws:

Exception

_processChildren

protected OAObject _processChildren(HashMap<String,Object> hm,
                                    Class<? extends OAObject> toClass,
                                    boolean bIsPreloading,
                                    int level)
                             throws Exception

Throws:

Exception

startElement

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

Throws:

SAXException

endElement

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

Throws:

SAXException

characters

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

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.

startDocument

protected void startDocument()
                      throws SAXException

Throws:

SAXException

endDocument

protected void endDocument()
                    throws SAXException

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 OAObject getRealObject(OAObject object)

getObject

protected OAObject getObject(Class toClass,
                             HashMap<String,Object> hm)

Called before creating and loading a new object.

Parameters:

toClass - type of object to create

hm - name/value, where name is uppercase.

Returns:

beforeLoadObject

protected void beforeLoadObject(OAObject obj,
                                HashMap<String,Object> hm)

afterLoadObject

protected void afterLoadObject(OAObject obj,
                               HashMap<String,Object> hm)

endObject

protected void endObject(OAObject obj,
                         boolean hasParent)

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

getPropertyName

protected String getPropertyName(OAObject obj,
                                 String propName)

resolveClassName

protected String resolveClassName(String className)

This can be overwritten to change/expand a class name

getDefaultHandler

protected DefaultHandler getDefaultHandler()

main

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

Throws:

Exception