/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: _XPersistObject.java,v $
* $Revision: 1.6 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
package ifc.io;
import lib.MultiMethodTest;
import util.ValueComparer;
import util.dbg;
import util.utils;
import com.sun.star.beans.Property;
import com.sun.star.beans.XPropertySet;
import com.sun.star.beans.XPropertySetInfo;
import com.sun.star.io.XActiveDataSink;
import com.sun.star.io.XActiveDataSource;
import com.sun.star.io.XInputStream;
import com.sun.star.io.XObjectInputStream;
import com.sun.star.io.XObjectOutputStream;
import com.sun.star.io.XOutputStream;
import com.sun.star.io.XPersistObject;
import com.sun.star.lang.XMultiServiceFactory;
import com.sun.star.uno.UnoRuntime;
/**
* Testing <code>com.sun.star.io.XPersistObject</code>
* interface methods :
* <ul>
* <li><code> getServiceName()</code></li>
* <li><code> write()</code></li>
* <li><code> read()</code></li>
* </ul> <p>
* This test need the following object relations :
* <ul>
* <li> <code>'OBJNAME'</code> : <code>String</code> value that
* contains service name which object represents.</li>
* <ul> <p>
* Test is <b> NOT </b> multithread compilant. <p>
* After test completion object environment has to be recreated.
* @see com.sun.star.io.XPersistObject
* @see com.sun.star.io.XObjectInputStream
* @see com.sun.star.io.XObjectOutputStream
*/
public class _XPersistObject extends MultiMethodTest {
public XPersistObject oObj = null;
XObjectInputStream iStream = null;
XObjectOutputStream oStream = null;
String sname = null;
boolean result = true;
/**
* Test calls the method and checks return value. <p>
* Has <b> OK </b> status if the method returns proper service names
* which is equal to <code>'OBJNAME'</code> relation value. <p>
*/
public void _getServiceName() {
result = true;
sname = oObj.getServiceName();
log.println("Method returned '" + sname + "'") ;
String objName = (String)tEnv.getObjRelation("OBJNAME");
if (objName == null) {
log.println("No OBJNAME relation!");
result = false;
} else {
result &= sname.equals(objName);
if (!result)
log.println("Name of object must be '" + objName +
"' but returned name is '" + sname +"'");
}
tRes.tested("getServiceName()", result);
}
/**
* Creates service get by <code>getServiceName</code> method and tries
* to read object written to stream by <code>write</code> method test.
* Then properties of object written and object read are compared. <p>
* Has <b>OK</b> status if all properties of two objects are equal
* and no exceptions were thrown. <p>
* The following method tests are to be completed successfully before :
* <ul>
* <li> <code> getServiceName() </code> : to have service name
* which has to be created </li>
* <li> <code> write() </code> : to write object tested into stream</li>
* </ul>
*/
public void _read() {
requiredMethod("getServiceName()");
requiredMethod("write()") ;
boolean bResult = true;
try {
Object noPS = tEnv.getObjRelation("noPS");
if ( noPS == null) {
XPropertySet objps = (XPropertySet)UnoRuntime.queryInterface(
XPropertySet.class, oObj);
XPropertySetInfo objpsi = objps.getPropertySetInfo();
Property[] objprops = objpsi.getProperties();
Object oCopy = ((XMultiServiceFactory)tParam.getMSF()).createInstance(sname);
XPersistObject persCopy = (XPersistObject)
UnoRuntime.queryInterface(XPersistObject.class, oCopy);
persCopy.read(iStream);
XPropertySet copyps = (XPropertySet)UnoRuntime.queryInterface(
XPropertySet.class, oCopy);
XPropertySetInfo copypsi = copyps.getPropertySetInfo();
Property[] copyprops = copypsi.getProperties();
for (int i = 0; i < copyprops.length; i++) {
Object cps = copyps.getPropertyValue(copyprops[i].Name);
Object ops = objps.getPropertyValue(objprops[i].Name);
boolean locRes = ( (ValueComparer.equalValue(cps,ops)) ||
(utils.isVoid(cps) && utils.isVoid(ops)) );
//transient properties aran't stored
if (isTransient(objprops[i])) locRes = true;
Object pseudo = tEnv.getObjRelation("PSEUDOPERSISTENT");
if ( (pseudo != null) && !locRes) {
String str = copyprops[i].Name;
locRes = ( (str.equals("Time")) || (str.equals("Date"))
|| (str.equals("FormatsSupplier"))
|| (str.equals("Text"))
|| (str.equals("Value"))
|| (str.indexOf("UserDefined")>0)
);
}
if (!locRes) {
log.println("Property '" + copyprops[i].Name
+ "' failed");
dbg.printPropertyInfo(objps, objprops[i].Name, log);
dbg.printPropertyInfo(copyps, copyprops[i].Name, log);
}
bResult &= locRes;
}
} else {
Object oCopy = ((XMultiServiceFactory)tParam.getMSF()).createInstance(sname);
XPersistObject persCopy = (XPersistObject)
UnoRuntime.queryInterface(XPersistObject.class, oCopy);
persCopy.read(iStream);
bResult = ( persCopy.getServiceName().equals(sname) );
}
} catch (com.sun.star.uno.Exception e) {
log.println("Exception occured : ");
e.printStackTrace(log) ;
bResult = false;
}
tRes.tested("read()", bResult);
}
/**
* Test calls the method and checks that
* no exceptions were thrown. <p>
* Has <b> OK </b> status if no exceptions were thrown. <p>
*/
public void _write() {
boolean bResult = true;
try {
initPipe();
oObj.write(oStream);
} catch (com.sun.star.io.IOException e) {
log.println("Exception occured while test. " + e);
bResult = false;
}
tRes.tested("write()", bResult);
}
/**
* Creates the following stream scheme <code>
* ObjectOutputStream -> Pipe -> ObjectInputStream </code> for writing/reading
* object.
*/
protected void initPipe() {
try {
Object aPipe = ((XMultiServiceFactory)tParam.getMSF()).createInstance
("com.sun.star.io.Pipe");
Object istream = ((XMultiServiceFactory)tParam.getMSF()).createInstance
("com.sun.star.io.ObjectInputStream");
Object ostream = ((XMultiServiceFactory)tParam.getMSF()).createInstance
("com.sun.star.io.ObjectOutputStream");
// Now the objects that aren't described anywhere
Object mistream = ((XMultiServiceFactory)tParam.getMSF()).createInstance
("com.sun.star.io.MarkableInputStream");
Object mostream = ((XMultiServiceFactory)tParam.getMSF()).createInstance
("com.sun.star.io.MarkableOutputStream");
XActiveDataSink xdSi = (XActiveDataSink)
UnoRuntime.queryInterface(XActiveDataSink.class, istream);
XActiveDataSource xdSo = (XActiveDataSource)
UnoRuntime.queryInterface(XActiveDataSource.class, ostream);
XActiveDataSink xdSmi = (XActiveDataSink)
UnoRuntime.queryInterface(XActiveDataSink.class, mistream);
XActiveDataSource xdSmo = (XActiveDataSource)
UnoRuntime.queryInterface(XActiveDataSource.class, mostream);
XInputStream miStream = (XInputStream)
UnoRuntime.queryInterface(XInputStream.class, mistream);
XOutputStream moStream = (XOutputStream)
UnoRuntime.queryInterface(XOutputStream.class, mostream);
XInputStream PipeIn = (XInputStream)
UnoRuntime.queryInterface(XInputStream.class, aPipe);
XOutputStream PipeOut = (XOutputStream)
UnoRuntime.queryInterface(XOutputStream.class,aPipe);
xdSi.setInputStream(miStream);
xdSo.setOutputStream(moStream);
xdSmi.setInputStream(PipeIn);
xdSmo.setOutputStream(PipeOut);
iStream = (XObjectInputStream)
UnoRuntime.queryInterface(XObjectInputStream.class, istream);
oStream = (XObjectOutputStream)
UnoRuntime.queryInterface(XObjectOutputStream.class, ostream);
} catch (com.sun.star.uno.Exception e) {
System.out.println("exc " + e);
}
}
public static boolean isTransient(Property prop) {
short attr = prop.Attributes;
return ((attr & com.sun.star.beans.PropertyAttribute.TRANSIENT) != 0);
}
}