odk/examples/DevelopersGuide/OfficeDev/Linguistic/SampleThesaurus.java

   1 /* -*- Mode: Java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  *  The Contents of this file are made available subject to the terms of
   5  *  the BSD license.
   6  *
   7  *  Copyright 2000, 2010 Oracle and/or its affiliates.
   8  *  All rights reserved.
   9  *
  10  *  Redistribution and use in source and binary forms, with or without
  11  *  modification, are permitted provided that the following conditions
  12  *  are met:
  13  *  1. Redistributions of source code must retain the above copyright
  14  *     notice, this list of conditions and the following disclaimer.
  15  *  2. Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in the
  17  *     documentation and/or other materials provided with the distribution.
  18  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
  19  *     contributors may be used to endorse or promote products derived
  20  *     from this software without specific prior written permission.
  21  *
  22  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  25  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  26  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  27  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  28  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  29  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  30  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  31  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  32  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  *
  34  *************************************************************************/
  35
  36 // uno
  37 import com.sun.star.lib.uno.helper.ComponentBase;
  38 import com.sun.star.uno.UnoRuntime;
  39
  40 // factories
  41 import com.sun.star.lang.XSingleComponentFactory;
  42
  43 // supported Interfaces
  44 import com.sun.star.linguistic2.XThesaurus;
  45 import com.sun.star.lang.XInitialization;
  46 import com.sun.star.lang.XServiceInfo;
  47 import com.sun.star.lang.XServiceDisplayName;
  48
  49 // Exceptions
  50 import com.sun.star.uno.Exception;
  51 //used Interfaces
  52 import com.sun.star.linguistic2.XMeaning;
  53 import com.sun.star.lang.Locale;
  54 import com.sun.star.beans.XPropertySet;
  55 import com.sun.star.beans.PropertyValue;
  56 import com.sun.star.uno.AnyConverter;
  57 import java.util.ArrayList;
  58
  59 public class SampleThesaurus extends ComponentBase implements
  60         XThesaurus,
  61         XInitialization,
  62         XServiceDisplayName,
  63         XServiceInfo
  64 {
  65     PropChgHelper               aPropChgHelper;
  66     ArrayList<?>                   aEvtListeners;
  67     boolean                     bDisposing;
  68
  69     public SampleThesaurus()
  70     {
  71         // names of relevant properties to be used
  72         String[] aProps = new String[]
  73             {
  74                 "IsIgnoreControlCharacters",
  75                 "IsUseDictionaryList",
  76             };
  77
  78         // this service has no listeners thus we may use the base class,
  79         // which is here basically used only to keep track of the
  80         // property set (and its lifetime) since it gets used in the
  81         // 'GetValueToUse' function
  82         aPropChgHelper  = new PropChgHelper( this, aProps );
  83
  84         aEvtListeners   = new ArrayList<Object>();
  85         bDisposing      = false;
  86     }
  87
  88     private boolean IsEqual( Locale aLoc1, Locale aLoc2 )
  89     {
  90         return aLoc1.Language.equals( aLoc2.Language ) &&
  91                aLoc1.Country .equals( aLoc2.Country )  &&
  92                aLoc1.Variant .equals( aLoc2.Variant );
  93     }
  94
  95     private boolean GetValueToUse(
  96             String          aPropName,
  97             boolean         bDefaultVal,
  98             PropertyValue[] aProps )
  99     {
 100         boolean bRes = bDefaultVal;
 101
 102         try
 103         {
 104             // use temporary value if supplied
 105             for (int i = 0;  i < aProps.length;  ++i)
 106             {
 107                 if (aPropName.equals( aProps[i].Name ))
 108                 {
 109                     Object aObj = aProps[i].Value;
 110                     if (AnyConverter.isBoolean( aObj ))
 111                     {
 112                         bRes = AnyConverter.toBoolean( aObj );
 113                         return bRes;
 114                     }
 115                 }
 116             }
 117
 118             // otherwise use value from property set (if available)
 119             XPropertySet xPropSet = aPropChgHelper.GetPropSet();
 120             if (xPropSet != null)   // should always be the case
 121             {
 122                 Object aObj = xPropSet.getPropertyValue( aPropName );
 123                 if (AnyConverter.isBoolean( aObj ))
 124                     bRes = AnyConverter.toBoolean( aObj );
 125             }
 126         }
 127         catch (Exception e) {
 128             bRes = bDefaultVal;
 129         }
 130
 131         return bRes;
 132     }
 133
 134     // __________ interface methods __________
 135
 136
 137
 138     //XSupportedLocales
 139
 140     public Locale[] getLocales()
 141         throws com.sun.star.uno.RuntimeException
 142     {
 143         Locale aLocales[] =
 144         {
 145             new Locale( "en", "US", "" )
 146         };
 147
 148         return aLocales;
 149     }
 150
 151     public boolean hasLocale( Locale aLocale )
 152         throws com.sun.star.uno.RuntimeException
 153     {
 154         boolean bRes = false;
 155         if (IsEqual( aLocale, new Locale( "en", "US", "" ) ))
 156             bRes = true;
 157         return bRes;
 158     }
 159
 160
 161     //XThesaurus
 162
 163     public XMeaning[] queryMeanings(
 164             String aTerm, Locale aLocale,
 165             PropertyValue[] aProperties )
 166         throws com.sun.star.lang.IllegalArgumentException,
 167                com.sun.star.uno.RuntimeException
 168     {
 169         if (IsEqual( aLocale, new Locale() ) || aTerm.length() == 0)
 170             return null;
 171
 172         // linguistic is currently not allowed to throw exceptions
 173         // thus we return null fwhich means 'word cannot be looked up'
 174         if (!hasLocale( aLocale ))
 175             return null;
 176
 177         // get values of relevant properties that may be used.
 178         //! The values for 'IsIgnoreControlCharacters' and 'IsUseDictionaryList'
 179         //! are handled by the dispatcher! Thus there is no need to access
 180         //! them here.
 181
 182         XMeaning[] aRes = null;
 183
 184         //!! This code needs to be replaced by code calling the actual
 185         //!! implementation of your thesaurus
 186         if (aTerm.equals( "house" ) &&
 187             IsEqual( aLocale, new Locale( "en", "US", "" ) ) )
 188         {
 189             aRes = new XMeaning[]
 190                 {
 191                     new XMeaning_impl( "a building where one lives",
 192                             new String[]{ "home", "place", "dwelling" } ),
 193                     new XMeaning_impl( "a group of people sharing common ancestry",
 194                             new String[]{ "family", "clan", "kindred" } ),
 195                     new XMeaning_impl( "to provide with lodging",
 196                             new String[]{ "room", "board", "put up" } )
 197                 };
 198         }
 199
 200         return aRes;
 201     }
 202
 203
 204
 205     // XServiceDisplayName
 206
 207     public String getServiceDisplayName( Locale aLocale )
 208         throws com.sun.star.uno.RuntimeException
 209     {
 210         return "Java Samples";
 211     }
 212
 213
 214     // XInitialization
 215
 216     public void initialize( Object[] aArguments )
 217         throws com.sun.star.uno.Exception,
 218                com.sun.star.uno.RuntimeException
 219     {
 220         int nLen = aArguments.length;
 221         if (2 == nLen)
 222         {
 223             XPropertySet xPropSet = UnoRuntime.queryInterface(
 224                                          XPropertySet.class, aArguments[0]);
 225             // start listening to property changes
 226             aPropChgHelper.AddAsListenerTo( xPropSet );
 227         }
 228     }
 229
 230
 231     // XServiceInfo
 232
 233     public boolean supportsService( String aServiceName )
 234         throws com.sun.star.uno.RuntimeException
 235     {
 236         String[] aServices = getSupportedServiceNames_Static();
 237         int i, nLength = aServices.length;
 238         boolean bResult = false;
 239
 240         for( i = 0; !bResult && i < nLength; ++i )
 241             bResult = aServiceName.equals( aServices[ i ] );
 242
 243         return bResult;
 244     }
 245
 246     public String getImplementationName()
 247         throws com.sun.star.uno.RuntimeException
 248     {
 249         return _aSvcImplName;
 250     }
 251
 252     public String[] getSupportedServiceNames()
 253         throws com.sun.star.uno.RuntimeException
 254     {
 255         return getSupportedServiceNames_Static();
 256     }
 257
 258     // __________ static things __________
 259
 260     public static String _aSvcImplName = SampleThesaurus.class.getName();
 261
 262     public static String[] getSupportedServiceNames_Static()
 263     {
 264         String[] aResult = { "com.sun.star.linguistic2.Thesaurus" };
 265         return aResult;
 266     }
 267
 268
 269     /**
 270      * Returns a factory for creating the service.
 271      * This method is called by the <code>JavaLoader</code>
 272      * <p>
 273      * @return  returns a <code>XSingleComponentFactory</code> for creating the component
 274      * @param   aImplName     the name of the implementation for which a service is desired
 275      * @see                  com.sun.star.comp.loader.JavaLoader
 276      */
 277     public static XSingleComponentFactory __getComponentFactory(
 278         String aImplName )
 279     {
 280         XSingleComponentFactory xSingleComponentFactory = null;
 281         if( aImplName.equals( _aSvcImplName ) )
 282         {
 283             xSingleComponentFactory = new OneInstanceFactory(
 284                     SampleThesaurus.class, _aSvcImplName,
 285                     getSupportedServiceNames_Static() );
 286         }
 287         return xSingleComponentFactory;
 288     }
 289 }
 290
 291 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */