qadevOOo/runner/basicrunner/basichelper/Filter.java

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Filter.java,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 package basicrunner.basichelper;
  31
  32 import com.sun.star.lang.XInitialization;
  33 import com.sun.star.lang.XServiceInfo;
  34 import com.sun.star.lang.XTypeProvider;
  35 import com.sun.star.uno.Type;
  36 import com.sun.star.container.XNameAccess;
  37 import com.sun.star.container.NoSuchElementException;
  38 import com.sun.star.uno.AnyConverter;
  39 import com.sun.star.uno.UnoRuntime;
  40 import com.sun.star.lang.XSingleServiceFactory;
  41 import com.sun.star.document.XFilter;
  42 import com.sun.star.beans.PropertyValue;
  43
  44
  45 /**
  46  * Provides an implementation of XFilter.
  47  * @see com.sun.star.document.XFilter
  48  * @see com.sun.star.lang.XServiceInfo
  49  * @see com.sun.star.lang.XSingleServiceFactory
  50  */
  51 public class Filter implements XServiceInfo, XSingleServiceFactory {
  52     /** The service name of this class **/
  53     static final String __serviceName = "basichelper.Filter";
  54     /** The actual filter **/
  55     static FilterImpl oFilter = null;
  56
  57     /**
  58      * Construct a new filter
  59      */
  60     public Filter() {
  61         oFilter = new FilterImpl();
  62     }
  63
  64     /**
  65      * Returns an instance of the filter.
  66      * Arguments are not supported here and will be ignored.
  67      * @param args The arguments.
  68      * @return The filter.
  69      */
  70     public Object createInstanceWithArguments(Object[] args) {
  71         return oFilter;
  72     }
  73
  74     /**
  75      * Returns an instance of the filter.
  76      * @return The filter.
  77      */
  78     public Object createInstance() {
  79         return createInstanceWithArguments(null);
  80     }
  81
  82     /**
  83      * Get a unique id for this implementation.
  84      * @return The id.
  85      */
  86     public byte[] getImplementationId() {
  87         return toString().getBytes();
  88     }
  89
  90     /**
  91      * Return all implemented types of this class.
  92      * @return The implemented UNO types.
  93      */
  94     public Type[] getTypes() {
  95         Class interfaces[] = getClass().getInterfaces();
  96
  97         Type types[] = new Type[interfaces.length];
  98         for(int i = 0; i < interfaces.length; ++ i)
  99             types[i] = new Type(interfaces[i]);
 100
 101         return types;
 102     }
 103
 104     /** Is this servioce supported?
 105      * @param name The service name.
 106      * @return True, if the service is supported.
 107      */
 108     public boolean supportsService(String name) {
 109         return __serviceName.equals(name);
 110     }
 111
 112     /**
 113      * Get all supported service names.
 114      * @return All supported servcices.
 115      */
 116     public String[] getSupportedServiceNames() {
 117         return new String[] {__serviceName};
 118     }
 119
 120     /**
 121      * Get the implementation name of this class.
 122      * @return The implementation name.
 123      */
 124     public String getImplementationName() {
 125         return getClass().getName();
 126     }
 127 }
 128
 129 /**
 130  * The actual filter implementation
 131  * @see com.sun.star.lang.XInitialization;
 132  * @see com.sun.star.lang.XTypeProvider;
 133  * @see com.sun.star.container.XNameAccess;
 134  */
 135 class FilterImpl implements XInitialization, XTypeProvider, XNameAccess {
 136     /** A state **/
 137     static String aState;
 138     /** A result **/
 139     static boolean bResult;
 140
 141     /**
 142      * Constructs a new filter.
 143      */
 144     public FilterImpl() {
 145         aState = "just created";
 146         bResult = false;
 147     }
 148
 149     /**
 150      * Get the element names
 151      * @return All element names.
 152      */
 153     public String[] getElementNames() {
 154         return new String[]{"State", "Result"};
 155     }
 156
 157     /**
 158      * Does this element exist?
 159      * @param name The element name.
 160      * @return True, if the name exists.
 161      */
 162     public boolean hasByName(String name) {
 163         return (name.equals("State") || name.equals("Result"));
 164     }
 165
 166     /**
 167      * Get an element by its name.
 168      * @param name The name of the element.
 169      * @return The value of the element.
 170      * @throws NoSuchElementException The element does not exist.
 171      */
 172     public Object getByName(String name) throws NoSuchElementException{
 173         if (name.equals("State"))
 174             return aState;
 175         else if (name.equals("Result"))
 176             return new Boolean(bResult);
 177         else
 178             throw new NoSuchElementException();
 179     }
 180
 181     /**
 182      * Are there elements
 183      * @return Always true.
 184      */
 185     public boolean hasElements() {
 186         return true;
 187     }
 188
 189     /**
 190      * Get element type.
 191      * @return null.
 192      */
 193     public Type getElementType() {
 194         return null;
 195     }
 196
 197     /**
 198      * Get a unique id for this implementation.
 199      * @return The id.
 200      */
 201     public byte[] getImplementationId() {
 202         return toString().getBytes();
 203     }
 204
 205     /**
 206      * Return all implemented types of this class.
 207      * @return The implemented UNO types.
 208      */
 209     public Type[] getTypes() {
 210         Class interfaces[] = getClass().getInterfaces();
 211
 212         Type types[] = new Type[interfaces.length];
 213         for(int i = 0; i < interfaces.length; ++ i)
 214             types[i] = new Type(interfaces[i]);
 215
 216         return types;
 217     }
 218
 219
 220     /**
 221      * Method initialize() creates a new thread that will try to start
 222      * filtering
 223      * @param parm1 An instance of XFilter
 224      * @see com.sun.star.document.XFilter
 225      * @throws Exception Is thrown, when initialize fails.
 226      */
 227     public void initialize(Object[] parm1) throws com.sun.star.uno.Exception {
 228         XFilter oFilter = (XFilter)UnoRuntime.queryInterface(
 229                                         XFilter.class, parm1[0]);
 230         PropertyValue[] FilterDesc = (PropertyValue[])AnyConverter.toArray(parm1[1]);
 231         aState = "just initialized";
 232         FilterThread aThread = new FilterThread(oFilter, FilterDesc);
 233         aThread.start();
 234     }
 235 }
 236
 237 /**
 238  * A thread for filtering.
 239  */
 240 class FilterThread extends Thread {
 241     /** The filter that is used **/
 242     XFilter oFilter = null;
 243     /** Filter descriptions **/
 244     PropertyValue[] FilterDesc = null;
 245
 246     /**
 247      * Construct the thread.
 248      * @param oObj The filter.
 249      * @param Desc The descriptions.
 250      */
 251     public FilterThread(XFilter oObj, PropertyValue[] Desc){
 252       oFilter = oObj;
 253       FilterDesc = Desc;
 254     }
 255
 256     /**
 257      * Let the thread run
 258      */
 259     public void run(){
 260         boolean bOK;
 261         try {
 262             FilterImpl.aState = "before filtering";
 263             bOK = oFilter.filter(FilterDesc);
 264             FilterImpl.aState = "filtering finished";
 265             FilterImpl.bResult = bOK;
 266         } catch (Exception e) {
 267             ConnectorImpl.aState = "error";
 268             throw new RuntimeException("Can't filtering exception"
 269                                                             + e.toString());
 270         }
 271     }
 272 }