com.viaoa.util.OAXMLReader1 Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of oa-core Show documentation
Show all versions of oa-core Show documentation
Object Automation library
/* Copyright 1999 Vince Via [email protected]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package com.viaoa.util;
import java.util.*;
import java.io.*;
import java.net.*;
import org.xml.sax.*;
import org.xml.sax.helpers.DefaultHandler;
import javax.xml.parsers.SAXParserFactory;
import javax.xml.parsers.SAXParser;
import com.viaoa.object.*;
import com.viaoa.hub.*;
import com.viaoa.ds.*;
/**
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 OAXMLWriter
*/
public class OAXMLReader1 extends DefaultHandler {
private String fileName;
String value;
int indent;
String className;
int total;
boolean bWithinTag;
Object[] stack = new Object[10];
private String decodeMessage;
protected boolean bUseRef;
protected Object refValue;
protected Object firstObject;
private Object nullObject = new Object();
private static final String XML_CLASS = "XML_CLASS";
private static final String XML_KEYONLY = "XML_KEYONLY";
private static final String XML_OBJECT = "XML_OBJECT";
private static final String XML_GUID = "XML_GUID";
protected Class conversionClass; // type of class that value needs to be converted to
protected Vector vecIncomplete, vecRoot;
protected HashMap hashGuid;
protected HashMap> hmMatch = new HashMap>();
private boolean bImportMatching = true;
// flag to know if OAXMLWriter wrote the object, which adds an additonal tag for the start of each object.
private int versionOAXML;
// objects that have been removed from a Hub and might not have been saved
// these objects will then be checked and saved at the end of the import
protected Vector vecRemoved = new Vector();
public OAXMLReader1() {
}
public OAXMLReader1(String fileName) {
setFileName(fileName);
}
public void setFileName(String fileName) {
this.fileName = fileName;
}
public String getFileName() {
return this.fileName;
}
public void setImportMatching(boolean b) {
this.bImportMatching = b;
}
public boolean getImportMatching() {
return this.bImportMatching;
}
/**
Used to parse and create OAObjects from an XML file.
@return topmost object from XML file.
*/
public Object read(String fileName) throws Exception {
setFileName(fileName);
return read();
}
/**
Used to parse and create OAObjects from an XML file.
@return topmost object from XML file.
*/
public Object read() throws Exception {
return parse(this.fileName);
}
/**
Used to parse and create OAObjects from an XML file.
@return topmost object from XML file.
*/
public Object parse() throws Exception {
reset();
Object obj = null;
obj = parse(fileName);
int x = vecRemoved.size();
for (int i=0; i= 0) vecRoot.set(pos, newValue);
}
/**
Used to unencrypt an XML file created by OAXMLWriter that used an encryption code.
@see OAXMLWriter#setEncodeMessage(String)
*/
public void setDecodeMessage(String msg) {
if (msg != null && msg.length() == 0) throw new IllegalArgumentException("DecodeMessage cant be an empty string");
decodeMessage = msg;
}
public String getDecodeMessage() {
return decodeMessage;
}
/**
SAXParser callback method.
*/
public void startElement(String namespaceURI, String sName, String qName, Attributes attrs) throws SAXException {
value = "";
bWithinTag = true;
String eName = sName; // element name
if ("".equals(eName)) eName = qName; // not namespaceAware
p(eName);
indent++;
if (indent == 1) {
versionOAXML = "OAXML".equalsIgnoreCase(eName) ? 1 : 0;
if (versionOAXML > 0) {
// ex:
if (attrs != null) {
for (int i = 0; i < attrs.getLength(); i++) {
String aName = attrs.getLocalName(i);
if (!"version".equalsIgnoreCase(aName)) continue;
String s = attrs.getValue(i);
if ("2.0".equals(s)) versionOAXML = 2;
break;
}
}
}
//todo later: if (versionOAXML == ??) throw new RuntimeException("OAXML ??? not supported");
stack[0] = null; // place holder
stack[1] = null; // place holder
return;
}
// stack ex: null | null | Department object | "Employees" | Hub object | Employee | "name" ...
// stack ex: null | null | Employee object | "Department" | Department object | "Manager" | Employee ...
if (stack.length <= indent) {
Object[] objs = new Object[stack.length + 20];
System.arraycopy(stack, 0, objs, 0, stack.length);
stack = objs;
}
stack[indent] = eName;
if (stack[indent-1] == null || (stack[indent-1] instanceof Vector) || (stack[indent-1] instanceof Hub) || (stack[indent-1] instanceof String)) {
// start of new object/hub
// whenever startElement() is called and the previous stack element has a String in it,
// then the next property is the reference Object/Hub
Class c = null;
try {
// Note: "INSERTCLASS" is used by JSON, and needs to be resolved by OAXMLReader here
if ("INSERTCLASS".equalsIgnoreCase(eName)) {
for (int i=indent-1; i>=0; i--) {
if (stack[i] == null) continue;
if (stack[i] instanceof Hub) {
eName = ((Hub) stack[i]).getObjectClass().getName();
stack[indent] = eName;
break;
}
if (stack[i] instanceof Hashtable) {
Class cx = (Class) ((Hashtable) stack[i]).get(XML_CLASS);
// find className of property
String prop = (String) stack[i+1];
OAObjectInfo oi = OAObjectInfoDelegate.getOAObjectInfo(cx);
cx = OAObjectInfoDelegate.getPropertyClass(oi, prop);
if (Hub.class.equals(cx)) {
OALinkInfo li = OAObjectInfoDelegate.getLinkInfo(oi, prop);
if (li != null) cx = li.getToClass();
}
eName = cx.getName();
stack[indent] = eName;
break;
}
}
}
if ("com.viaoa.hub.Hub".equals(eName)) {
c = Hub.class;
}
else {
eName = resolveClassName(eName);
if (eName == null) eName = "com.viaoa.object.OAObject";
c = Class.forName(eName);
}
}
catch (Exception e) {
throw new SAXException("cant find class "+eName+" Error: "+e);
}
if (c.equals(Hub.class)) {
String className = attrs.getValue("ObjectClass");
// Note: "INSERTCLASS" is used by JSON, and needs to be resolved by OAXMLReader here
if ("INSERTCLASS".equalsIgnoreCase(className)) {
for (int i=indent-1; i>=0; i--) {
if (stack[i] instanceof Hashtable) {
Class cx = (Class) ((Hashtable) stack[i]).get(XML_CLASS);
// find className of property
String prop = (String) stack[i+1];
OAObjectInfo oi = OAObjectInfoDelegate.getOAObjectInfo(cx);
cx = OAObjectInfoDelegate.getPropertyClass(oi, prop);
if (Hub.class.equals(cx)) {
OALinkInfo li = OAObjectInfoDelegate.getLinkInfo(oi, prop);
if (li != null) cx = li.getToClass();
}
className = cx.getName();
break;
}
}
}
className = resolveClassName(className);
int tot;
String stot = attrs.getValue("total");
if (OAString.isEmpty(stot)) tot = 0;
else tot = OAConverter.toInt(stot);
startHub(className, tot);
if (indent > 3) {
// get Hub from previous object
Hashtable hash = (Hashtable) stack[indent-2];
Vector vec = (Vector) hash.get(stack[indent-1]); // name of Hub property
if (vec == null) {
vec = new Vector(43,25);
hash.put(stack[indent-1], vec); // propertyName, vector to hold objects
}
stack[indent] = vec; // add objects to this
}
else {
try {
Hub h = new Hub(Class.forName(resolveClassName(className)));
stack[indent] = h;
vecRoot.add(h);
}
catch (Exception e) {
throw new SAXException("Error getting Class for Hub: "+e);
}
}
if (firstObject == null && stack[indent-1] == null) firstObject = nullObject;
}
else {
// create hashtable to hold values
Hashtable hash = new Hashtable(23, .75f);
hash.put(XML_CLASS, c);
stack[indent] = hash;
if (attrs != null) {
for (int i = 0; i < attrs.getLength(); i++) {
String aName = attrs.getLocalName(i); // Attr name
if ("".equals(aName)) aName = attrs.getQName(i);
String aValue = attrs.getValue(i);
if (aName.equalsIgnoreCase("keyonly")) hash.put(XML_KEYONLY, XML_KEYONLY);
else if (aName.equalsIgnoreCase("guid")) hash.put(XML_GUID, aValue);
else processProperty(aName, aValue, null, hash);
}
}
}
}
else {
// this needs to check to see if there is a "class" attribute
conversionClass = null;
String sclass = attrs.getValue("class");
if (sclass != null) {
try {
conversionClass = Class.forName(resolveClassName(sclass));
}
catch (Exception e) {
throw new SAXException("cant create class "+sclass+" Error:"+e);
}
}
}
}
// 20150730
class Holder {
Class c;
OAObjectKey key;
public Holder(Class c, OAObjectKey key) {
this.c = c;
this.key = key;
}
}
/**
SAXParser callback method.
*/
public void endElement(String namespaceURI, String sName, String qName) throws SAXException {
bWithinTag = false;
String eName = sName; // element name
if ("".equals(eName)) eName = qName; // not namespaceAware
Object stackobj = stack[indent];
if (stackobj instanceof Hashtable) {
// ending an object
/*
1: create OAObjectKey using propertyId values
2: call OAObjectCacheDelegate to find object
3: if not found, create new object
4: load/update property values
*/
final Hashtable hash = (Hashtable) stackobj;
final boolean bKeyOnly = hash.remove(XML_KEYONLY) != null;
final String guid = (String) hash.remove(XML_GUID);
final Class c = (Class) hash.get(XML_CLASS);
OAObjectInfo oi = OAObjectInfoDelegate.getOAObjectInfo(c);
String[] ids = oi.getIdProperties();
Object[] values = new Object[ ids == null ? 0 : ids.length ];
for (int i=0; i 0) {
for (int i=0; i 0) {
if (bKeyOnly) {
HashMap hm = hmMatch.get(c);
if (hm != null) object = hm.get(key);
}
else {
OASelect sel = new OASelect(c);
sel.setFilter(new OAFilter() {
@Override
public boolean isUsed(Object obj) {
if (!(obj instanceof OAObject)) return false;
for (int i=0; i hm = hmMatch.get(c);
if (hm == null) {
hm = new HashMap();
hmMatch.put(c, hm);
}
hm.put(key, object);
}
}
}
else {
if (ids != null && ids.length > 0) {
object = OAObjectCacheDelegate.get(c, key);
}
}
if (object == null && guid != null) {
object = (OAObject) hashGuid.get(guid);
}
if (bKeyOnly) {
if (stack[indent-1] instanceof Vector) {
Vector vec = (Vector) stack[indent-1];
if (object != null) vec.addElement(object);
else if (guid != null) vec.addElement(XML_GUID+guid);
else if (matchProps == null || matchProps.length == 0) {
vec.addElement(key);
}
else {
// 20150730
vec.add(new Holder(c, key));
}
}
else if (stack[indent-1] instanceof Hub) {
Hub h = (Hub) stack[indent-1];
if (object != null) h.add(object);
else {
// note: should not ever need a Holder
h.add(key);
}
}
else if (indent > 3) {
// use this value when updating property
bUseRef = true;
if (object != null) refValue = object;
else if (guid != null) refValue = XML_GUID+guid;
else if (matchProps == null || matchProps.length == 0) {
refValue = key;
}
else {
// 20150730
refValue = new Holder(c, key);
}
}
}
else {
// create object, only load objectId properties
if (matchProps == null || matchProps.length == 0) {
if (object == null && ids != null && ids.length > 0) {
if (object == null) object = (OAObject) OADataSource.getObject(c, key);
}
}
if (object == null) {
try {
OAThreadLocalDelegate.setLoading(true);
object = createNewObject(c);
// set property ids
if (matchProps == null || matchProps.length == 0) {
for (int i=0; ids != null && i hm = hmMatch.get(c);
if (hm == null) {
hm = new HashMap();
hmMatch.put(c, hm);
}
hm.put(key, object);
}
}
catch (Exception e) {
throw new SAXException("cant create object for class "+c.getName()+" Error:"+e, e);
}
finally {
OAThreadLocalDelegate.setLoading(false);
}
}
else {
}
if (guid != null) hashGuid.put(guid, object);
boolean bIncomplete = true;
if (stack[indent-1] == null) bIncomplete = false;
else if (stack[indent-1] instanceof Hub) bIncomplete = false;
if (bIncomplete) {
hash.put(XML_OBJECT, object);
vecIncomplete.addElement(hash);
}
else {
// 20150730 use two passes
int x = vecIncomplete.size();
Vector vec = new Vector();
for (int i=0; i 3) {
// use this value when updating property
bUseRef = true;
refValue = object;
}
}
}
else if (stackobj == null) {
}
else if (stackobj instanceof Vector) {
}
else if (stackobj instanceof Hub) { // root level Hub
}
else { // String (Property Name)
Hashtable hash = (Hashtable)stack[indent-1];
if (!(hash.get(eName) instanceof Vector)) {
processProperty(eName, value, conversionClass, hash);
} // else it was a Hub property
conversionClass = null;
}
indent--;
p("/"+eName);
}
protected void processProperty(String eName, String value, Class conversionClass, Hashtable hash) {
Object objValue = value;
if (bUseRef) {
bUseRef = false;
objValue = refValue;
}
else {
if (decodeMessage != null && value != null && value.startsWith(decodeMessage)) {
objValue = Base64.decode(value.substring(decodeMessage.length()));
}
}
// p(""+objValue);
if (objValue != null) hash.put(eName.toUpperCase(), objValue);
}
// return null to ignore property
protected String getPropertyName(OAObject obj, String propName) {
return propName;
}
protected boolean processProperties(OAObject object, Hashtable hash) {
Class c = (Class) hash.get(XML_CLASS);
Object objx = hash.remove(XML_OBJECT);
String guid = (String) hash.remove(XML_GUID);
boolean b = _processProperties(object, hash);
hash.put(XML_CLASS, c);
if (objx != null) hash.put(XML_OBJECT, objx);
if (guid != null) hash.put(XML_GUID, guid);
return b;
}
private boolean _processProperties(final OAObject object, Hashtable hash) {
if (object == null) return false;
boolean bResult = true;
boolean bLoadingObject = false;
try {
if (object.getNew()) {
bLoadingObject = true;
OAThreadLocalDelegate.setLoading(true);
if (OAObjectCSDelegate.isServer(object)) OAThreadLocalDelegate.setSuppressCSMessages(true);
// no, needs to have OAObjectEventDelegate.firePropertyChange() process property changes
// since it has already created the object w/o setLoading(true), which means that there are null primitive properties
// that would not be "unset" if firePropertyChange() was not ran.
}
final Class c = (Class) hash.remove(XML_CLASS);
OAObjectInfo oi = OAObjectInfoDelegate.getOAObjectInfo(c);
Enumeration enumx = hash.keys();
for ( ;enumx.hasMoreElements(); ) {
Object k = enumx.nextElement();
Object v = hash.get(k);
if (v == object) continue;
k = getPropertyName(object, (String)k);
if (k == null) continue;
// 20150730
if (v instanceof Holder) {
Holder h = (Holder) v;
HashMap hm = hmMatch.get(h.c);
if (hm != null) {
v = hm.get(h.key);
}
}
if (v instanceof Vector) {
if (!bResult) continue;
Vector vec = (Vector) v;
// change guid objects to real objects
int x = vec.size();
for (int ix=0; ix < x; ix++) {
Object o = vec.elementAt(ix);
if (o instanceof String && ((String)o).startsWith(XML_GUID)) {
String guid = ((String)o).substring(XML_GUID.length());
o = hashGuid.get(guid);
if (o == null) {
bResult = false;
//System.out.println("Error: could not find object in hashGuid *****");//qqqqqqq
}
else vec.set(ix, o); // replace
}
else if (o instanceof Holder) {
// 20150730
Holder h = (Holder) o;
HashMap hm = hmMatch.get(h.c);
if (hm != null) {
o = hm.get(h.key);
if (o == null) {
bResult = false;
}
else vec.set(ix, o); // replace
}
}
}
// 2006/05/22 was: Hub h = object.getHub((String)k);
Hub h = (Hub) object.getProperty((String) k);
if (h == null) {
if (vec.size() > 0) System.out.println("ERROR in OAXMLReader: Object:"+object+" Property:"+k+" error:returned null value, should be a Hub");
}
else {
h.loadAllData();
// remove objects in Hub that are not in Vector
for (int i=0; ;i++) {
Object obj = h.elementAt(i);
if (obj == null) break;
if (vec.indexOf(obj) < 0) {
h.remove(obj);
vecRemoved.addElement(obj);
i--;
}
}
// add objects in Vector that are not in Hub
x = vec.size();
for (int ix=0; ix < x; ix++) {
Object o = vec.elementAt(ix);
if (o instanceof Holder) {
Holder hx = (Holder) o;
HashMap hm = hmMatch.get(hx.c);
if (hm != null) {
o = hm.get(hx.key);
}
else {
// 20150730 should not happen, this can be removed later
System.out.println("OAXMLReader error, value was not in hmMatch");
continue; //qqq
}
}
if (h.getObject(o) == null) h.add(o);
// position objects in Hub to match order of objects in Vector
int pos = h.getPos(o);
if (pos != ix) h.move(pos, ix);
}
}
}
else if (OAObjectInfoDelegate.isHubProperty(oi, (String)k)) {
// empty hub, otherwise "v" would have been a Vector
}
else if (v != null && (v instanceof String) && ((String)v).startsWith(XML_GUID)) {
String guid = ((String)v).substring(XML_GUID.length());
v = hashGuid.get(guid);
if (v == null) {
bResult = false;
// System.out.println("Error: could not find object in hashGuid *****");//qqqqqqq
}
else {
v = getValue(object, (String)k, v); // hook method for subclass
object.setProperty((String)k, v);
}
}
else if (v instanceof OAObjectKey) {
// try to find "real" object
Class cx = OAObjectInfoDelegate.getPropertyClass(c, (String) k);
v = OAObjectCacheDelegate.get(cx, (OAObjectKey) v);
if (v == null) {
bResult = false;
}
else {
v = getValue(object, (String)k, v); // hook method for subclass
object.setProperty((String)k, v);
}
}
else {
if (v instanceof String) {
Class cx = OAObjectInfoDelegate.getPropertyClass(c, (String) k);
if (cx != null && !cx.equals(String.class) ) {
v = convertToObject((String)k, (String) v, cx);
}
}
v = getValue(object, (String)k, v); // hook method for subclass
object.setProperty((String)k, v);
}
}
}
finally {
if (bLoadingObject) {
if (bResult) object.afterLoad();
OAThreadLocalDelegate.setLoading(false);
if (OAObjectCSDelegate.isServer(object)) OAThreadLocalDelegate.setSuppressCSMessages(false);
}
}
return bResult;
}
/**
SAXParser callback method.
*/
public void characters(char buf[], int offset, int len) throws SAXException {
if (bWithinTag && value != null) {
String s = new String(buf, offset, len);
value += OAString.decodeIllegalXML(s);
}
}
private int holdIndent;
private String sIndent="";
void p(String s) {
if (true) return;
if (indent != holdIndent) {
holdIndent = indent;
sIndent = "";
for (int i=0; i © 2015 - 2025 Weber Informatics LLC | Privacy Policy