qadevOOo/tests/java/mod/_sw/SwXDocumentIndex.java

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18
  19 package mod._sw;
  20
  21 import java.io.PrintWriter;
  22
  23 import lib.StatusException;
  24 import lib.TestCase;
  25 import lib.TestEnvironment;
  26 import lib.TestParameters;
  27 import util.SOfficeFactory;
  28
  29 import com.sun.star.text.XText;
  30 import com.sun.star.text.XTextContent;
  31 import com.sun.star.text.XTextCursor;
  32 import com.sun.star.text.XTextRange;
  33 import com.sun.star.text.XTextDocument;
  34 import com.sun.star.uno.UnoRuntime;
  35
  36
  37 /**
  38  * Test for object which is represented by service
  39  * <code>com.sun.star.text.DocumentIndex</code>. <p>
  40  * Object implements the following interfaces :
  41  * <ul>
  42  *  <li> <code>com::sun::star::lang::XComponent</code></li>
  43  *  <li> <code>com::sun::star::text::XDocumentIndex</code></li>
  44  *  <li> <code>com::sun::star::text::BaseIndex</code></li>
  45  *  <li> <code>com::sun::star::text::XTextContent</code></li>
  46  *  <li> <code>com::sun::star::text::DocumentIndex</code></li>
  47  * </ul> <p>
  48  * This object test <b> is NOT </b> designed to be run in several
  49  * threads concurently.
  50  * @see com.sun.star.lang.XComponent
  51  * @see com.sun.star.text.XDocumentIndex
  52  * @see com.sun.star.text.BaseIndex
  53  * @see com.sun.star.text.XTextContent
  54  * @see com.sun.star.text.DocumentIndex
  55  * @see ifc.lang._XComponent
  56  * @see ifc.text._XDocumentIndex
  57  * @see ifc.text._BaseIndex
  58  * @see ifc.text._XTextContent
  59  * @see ifc.text._DocumentIndex
  60  */
  61 public class SwXDocumentIndex extends TestCase {
  62     XTextDocument xTextDoc;
  63
  64     /**
  65     * Creates text document.
  66     */
  67     @Override
  68     protected void initialize( TestParameters tParam, PrintWriter log ) {
  69         SOfficeFactory SOF = SOfficeFactory.getFactory( tParam.getMSF() );
  70         try {
  71             log.println( "creating a textdocument" );
  72             xTextDoc = SOF.createTextDoc( null );
  73         } catch ( com.sun.star.uno.Exception e ) {
  74             e.printStackTrace( log );
  75             throw new StatusException( "Couldn't create document", e );
  76         }
  77     }
  78
  79     /**
  80     * Disposes text document.
  81     */
  82     @Override
  83     protected void cleanup( TestParameters tParam, PrintWriter log ) {
  84         log.println( "    disposing xTextDoc " );
  85         util.DesktopTools.closeDoc(xTextDoc);
  86     }
  87
  88     /**
  89     * Creating a Testenvironment for the interfaces to be tested.
  90     * Creates an instance of the service
  91     * <code>com.sun.star.text.DocumentIndex</code>, then created document index
  92     * is inserted to the text of the document as content.
  93     *
  94     */
  95     @Override
  96     protected TestEnvironment createTestEnvironment(TestParameters tParam, PrintWriter log) {
  97         XTextContent xTC = null;
  98         Object instance = null;
  99
 100         SOfficeFactory.getFactory(tParam.getMSF());
 101         log.println( "creating a test environment" );
 102         try {
 103             xTC = SOfficeFactory.createIndex(xTextDoc, "com.sun.star.text.DocumentIndex");
 104             instance = SOfficeFactory.createIndex(xTextDoc, "com.sun.star.text.DocumentIndex");
 105         }
 106         catch ( com.sun.star.uno.Exception e) {
 107             e.printStackTrace(log);
 108             throw new StatusException("Couldn't create the Index", e);
 109         }
 110
 111         XText oText = xTextDoc.getText();
 112         XTextCursor oCursor = oText.createTextCursor();
 113
 114         log.println("inserting the Index into text document");
 115         try {
 116             oText.insertTextContent(oCursor, xTC, false);
 117         } catch (com.sun.star.lang.IllegalArgumentException e) {
 118             e.printStackTrace(log);
 119             throw new StatusException("Couldn't insert the Index", e);
 120         }
 121
 122         TestEnvironment tEnv = new TestEnvironment(xTC);
 123
 124         tEnv.addObjRelation("CONTENT", UnoRuntime.queryInterface(XTextContent.class,instance));
 125         oCursor.gotoEnd(false);
 126         tEnv.addObjRelation("RANGE", UnoRuntime.queryInterface(XTextRange.class, oCursor));
 127
 128         // relation for XDocumentIndex
 129         tEnv.addObjRelation("TextDoc", xTextDoc);
 130
 131         return tEnv;
 132     } // finish method getTestEnvironment
 133
 134 }    // finish class SwXDocumentIndex
 135