/*************************************************************************
*
* 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: XMLSettingsExporter.java,v $
* $Revision: 1.9 $
*
* 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 mod._sc;
import java.io.PrintWriter;
import lib.StatusException;
import lib.TestCase;
import lib.TestEnvironment;
import lib.TestParameters;
import util.SOfficeFactory;
import util.XMLTools;
import com.sun.star.beans.XPropertySet;
import com.sun.star.document.XExporter;
import com.sun.star.frame.XController;
import com.sun.star.frame.XModel;
import com.sun.star.lang.XComponent;
import com.sun.star.lang.XMultiServiceFactory;
import com.sun.star.uno.Any;
import com.sun.star.uno.Type;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.uno.XInterface;
import com.sun.star.xml.sax.XDocumentHandler;
/**
* Test for object which is represented by service
* <code>com.sun.star.comp.Calc.XMLSettingsExporter</code>. <p>
* Object implements the following interfaces :
* <ul>
* <li><code>com::sun::star::lang::XInitialization</code></li>
* <li><code>com::sun::star::document::ExportFilter</code></li>
* <li><code>com::sun::star::document::XFilter</code></li>
* <li><code>com::sun::star::document::XExporter</code></li>
* <li><code>com::sun::star::beans::XPropertySet</code></li>
* </ul>
* @see com.sun.star.lang.XInitialization
* @see com.sun.star.document.ExportFilter
* @see com.sun.star.document.XFilter
* @see com.sun.star.document.XExporter
* @see com.sun.star.beans.XPropertySet
* @see ifc.lang._XInitialization
* @see ifc.document._ExportFilter
* @see ifc.document._XFilter
* @see ifc.document._XExporter
* @see ifc.beans._XPropertySet
*/
public class XMLSettingsExporter extends TestCase {
static XComponent xSheetDoc;
/**
* New spreadsheet document created.
*/
protected void initialize( TestParameters tParam, PrintWriter log ) {
SOfficeFactory SOF = SOfficeFactory.getFactory( (XMultiServiceFactory)tParam.getMSF() );
try {
log.println( "creating a calc document" );
xSheetDoc = SOF.openDoc("scalc","_blank");
} catch ( com.sun.star.uno.Exception e ) {
// Some exception occures.FAILED
e.printStackTrace( log );
throw new StatusException( "Couldn't create document", e );
}
}
/**
* Spreadsheet document disposed
*/
protected void cleanup( TestParameters tParam, PrintWriter log ) {
log.println( " disposing xCalcDoc " );
util.DesktopTools.closeDoc(xSheetDoc);
}
/**
* Creating a Testenvironment for the interfaces to be tested.
* Creates an instance of the service
* <code>com.sun.star.comp.Calc.XMLSettingsExporter</code> with
* argument which is an implementation of <code>XDocumentHandler</code>
* and which can check if required tags and character data is
* exported. <p>
* The calc document is set as a source document for exporter
* created. Sets settings' property 'ShowGrid' to 'false', then checks
* it in the exported xml document.<p>
* Object relations created :
* <ul>
* <li> <code>'MediaDescriptor'</code> for
* {@link ifc.document._XFilter} interface </li>
* <li> <code>'XFilter.Checker'</code> for
* {@link ifc.document._XFilter} interface </li>
* <li> <code>'SourceDocument'</code> for
* {@link ifc.document._XExporter} interface </li>
* </ul>
*/
public synchronized TestEnvironment createTestEnvironment( TestParameters tParam,
PrintWriter log )
throws StatusException {
XMultiServiceFactory xMSF = (XMultiServiceFactory)tParam.getMSF() ;
XInterface oObj = null;
SettingsFilterChecker filter = new SettingsFilterChecker(log);
Any arg = new Any(new Type(XDocumentHandler.class), filter);
try {
oObj = (XInterface) xMSF.createInstanceWithArguments(
"com.sun.star.comp.Calc.XMLSettingsExporter",
new Object[] {arg} );
XExporter xEx = (XExporter) UnoRuntime.queryInterface
(XExporter.class,oObj);
xEx.setSourceDocument(xSheetDoc);
//set some settings
XModel xSheetModel = (XModel)
UnoRuntime.queryInterface(XModel.class, xSheetDoc);
XController xController = xSheetModel.getCurrentController();
XPropertySet xPropSet = (XPropertySet)
UnoRuntime.queryInterface(XPropertySet.class, xController);
xPropSet.setPropertyValue("ShowGrid", "false");
util.CalcTools.fillCalcSheetWithContent(xSheetDoc,1, 3, 3, 50, 50);
} catch (com.sun.star.uno.Exception e) {
e.printStackTrace(log) ;
throw new StatusException("Can't create component.", e) ;
} catch (java.lang.Exception e) {
e.printStackTrace(log);
throw new StatusException("Can't create environment.", e);
}
//Create and prepare filter
// adding tags which must be contained in XML output
filter.addTag(new XMLTools.Tag("office:document-settings") );
filter.addTagEnclosed(
new XMLTools.Tag("office:settings"),
new XMLTools.Tag("office:document-settings") );
filter.addCharactersEnclosed(
"false",
new XMLTools.Tag("config:config-item", "config:name", "ShowGrid") );
// create testobject here
log.println( "creating a new environment" );
TestEnvironment tEnv = new TestEnvironment( oObj );
tEnv.addObjRelation("MediaDescriptor", XMLTools.createMediaDescriptor(
new String[] {"FilterName"},
new Object[] {"scalc: StarOffice XML (Calc)"}));
tEnv.addObjRelation("SourceDocument",xSheetDoc);
tEnv.addObjRelation("XFilter.Checker", filter) ;
return tEnv;
}
/**
* This class checks the XML for tags and data required and returns
* checking result to <code>XFilter</code> interface test. All
* the information about errors occured in XML data is written
* to log specified.
* @see ifc.document._XFilter
*/
protected class SettingsFilterChecker extends XMLTools.XMLChecker
implements ifc.document._XFilter.FilterChecker {
/**
* Creates a class which will write information
* into log specified.
*/
public SettingsFilterChecker(PrintWriter log) {
super(log, false) ;
}
/**
* <code>_XFilter.FilterChecker</code> interface method
* which returns the result of XML checking.
* @return <code>true</code> if the XML data exported was
* valid (i.e. all necessary tags and character data exists),
* <code>false</code> if some errors occured.
*/
public boolean checkFilter() {
return check();
}
}
}