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

   1 /*************************************************************************
   2  *
   3  *  $RCSfile: SampleHyphenator.java,v $
   4  *
   5  *  $Revision: 1.3 $
   6  *
   7  *  last change: $Author: hr $ $Date: 2003-06-30 15:40:57 $
   8  *
   9  *  The Contents of this file are made available subject to the terms of
  10  *  the BSD license.
  11  *
  12  *  Copyright (c) 2003 by Sun Microsystems, Inc.
  13  *  All rights reserved.
  14  *
  15  *  Redistribution and use in source and binary forms, with or without
  16  *  modification, are permitted provided that the following conditions
  17  *  are met:
  18  *  1. Redistributions of source code must retain the above copyright
  19  *     notice, this list of conditions and the following disclaimer.
  20  *  2. Redistributions in binary form must reproduce the above copyright
  21  *     notice, this list of conditions and the following disclaimer in the
  22  *     documentation and/or other materials provided with the distribution.
  23  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
  24  *     contributors may be used to endorse or promote products derived
  25  *     from this software without specific prior written permission.
  26  *
  27  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  30  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  31  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  32  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  33  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  34  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  35  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  36  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  37  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38  *
  39  *************************************************************************/
  40
  41 // uno
  42 import com.sun.star.lib.uno.helper.ComponentBase;
  43 import com.sun.star.uno.UnoRuntime;
  44
  45 // factories
  46 import com.sun.star.lang.XMultiServiceFactory;
  47 import com.sun.star.lang.XSingleServiceFactory;
  48
  49 // supported Interfaces
  50 import com.sun.star.linguistic2.XHyphenator;
  51 import com.sun.star.linguistic2.XLinguServiceEventBroadcaster;
  52 import com.sun.star.lang.XInitialization;
  53 import com.sun.star.lang.XComponent;
  54 import com.sun.star.lang.XServiceInfo;
  55 import com.sun.star.lang.XServiceDisplayName;
  56
  57 // Exceptions
  58 import com.sun.star.uno.Exception;
  59 import com.sun.star.uno.RuntimeException;
  60 import com.sun.star.lang.IllegalArgumentException;
  61
  62 //used Interfaces
  63 import com.sun.star.linguistic2.XLinguServiceEventListener;
  64 import com.sun.star.linguistic2.XHyphenatedWord;
  65 import com.sun.star.linguistic2.XPossibleHyphens;
  66 import com.sun.star.lang.Locale;
  67 import com.sun.star.lang.XEventListener;
  68 import com.sun.star.lang.EventObject;
  69 import com.sun.star.beans.XPropertySet;
  70 import com.sun.star.beans.PropertyValue;
  71 import com.sun.star.uno.AnyConverter;
  72 import com.sun.star.lang.XTypeProvider;
  73 import com.sun.star.uno.XInterface;
  74 import com.sun.star.uno.Type;
  75
  76 import java.util.ArrayList;
  77
  78 public class SampleHyphenator extends ComponentBase implements
  79         XHyphenator,
  80         XLinguServiceEventBroadcaster,
  81         XInitialization,
  82         XServiceDisplayName,
  83         XServiceInfo
  84 {
  85     PropChgHelper_Hyph          aPropChgHelper;
  86     ArrayList                   aEvtListeners;
  87     boolean                     bDisposing;
  88
  89     public SampleHyphenator()
  90     {
  91         // names of relevant properties to be used
  92         String[] aProps = new String[]
  93             {
  94                 "IsIgnoreControlCharacters",
  95                 "IsUseDictionaryList",
  96                 "IsGermanPreReform",
  97                 "HyphMinLeading",
  98                 "HyphMinTrailing",
  99                 "HyphMinWordLength"
 100             };
 101         aPropChgHelper  = new PropChgHelper_Hyph( (XHyphenator) this, aProps );
 102         aEvtListeners   = new ArrayList();;
 103         bDisposing      = false;
 104     }
 105
 106     private boolean IsEqual( Locale aLoc1, Locale aLoc2 )
 107     {
 108         return aLoc1.Language.equals( aLoc2.Language ) &&
 109                aLoc1.Country .equals( aLoc2.Country )  &&
 110                aLoc1.Variant .equals( aLoc2.Variant );
 111     }
 112
 113     private boolean GetValueToUse(
 114             String          aPropName,
 115             boolean         bDefaultVal,
 116             PropertyValue[] aProps )
 117     {
 118         boolean bRes = bDefaultVal;
 119
 120         try
 121         {
 122             // use temporary value if supplied
 123             for (int i = 0;  i < aProps.length;  ++i)
 124             {
 125                 if (aPropName.equals( aProps[i].Name ))
 126                 {
 127                     Object aObj = aProps[i].Value;
 128                     if (AnyConverter.isBoolean( aObj ))
 129                     {
 130                         bRes = AnyConverter.toBoolean( aObj );
 131                         return bRes;
 132                     }
 133                 }
 134             }
 135
 136             // otherwise use value from property set (if available)
 137             XPropertySet xPropSet = aPropChgHelper.GetPropSet();
 138             if (xPropSet != null)   // should always be the case
 139             {
 140                 Object aObj = xPropSet.getPropertyValue( aPropName );
 141                 if (AnyConverter.isBoolean( aObj ))
 142                     bRes = AnyConverter.toBoolean( aObj );
 143             }
 144         }
 145         catch (Exception e) {
 146             bRes = bDefaultVal;
 147         }
 148
 149         return bRes;
 150     }
 151
 152     private short GetValueToUse(
 153             String          aPropName,
 154             short           nDefaultVal,
 155             PropertyValue[] aProps )
 156     {
 157         short nRes = nDefaultVal;
 158
 159         try
 160         {
 161             // use temporary value if supplied
 162             for (int i = 0;  i < aProps.length;  ++i)
 163             {
 164                 if (aPropName.equals( aProps[i].Name ))
 165                 {
 166                     Object aObj = aProps[i].Value;
 167                     if (AnyConverter.isShort( aObj ))
 168                     {
 169                         nRes = AnyConverter.toShort( aObj );
 170                         return nRes;
 171                     }
 172                 }
 173             }
 174
 175             // otherwise use value from property set (if available)
 176             XPropertySet xPropSet = aPropChgHelper.GetPropSet();
 177             if (xPropSet != null)   // should always be the case
 178             {
 179                     Object aObj = xPropSet.getPropertyValue( aPropName );
 180                     if (AnyConverter.isShort( aObj ))
 181                         nRes = AnyConverter.toShort( aObj );
 182             }
 183         }
 184         catch (Exception e) {
 185             nRes = nDefaultVal;
 186         }
 187
 188         return nRes;
 189     }
 190
 191     // __________ interface methods __________
 192
 193
 194     //*****************
 195     //XSupportedLocales
 196     //*****************
 197     public Locale[] getLocales()
 198         throws com.sun.star.uno.RuntimeException
 199     {
 200         Locale aLocales[] =
 201         {
 202             new Locale( "de", "DE", "" ),
 203             new Locale( "en", "US", "" )
 204         };
 205
 206         return aLocales;
 207     }
 208
 209     public boolean hasLocale( Locale aLocale )
 210         throws com.sun.star.uno.RuntimeException
 211     {
 212         boolean bRes = false;
 213         if ( IsEqual( aLocale, new Locale( "de", "DE", "" ) )  ||
 214              IsEqual( aLocale, new Locale( "en", "US", "" ) ))
 215             bRes = true;
 216         return bRes;
 217     }
 218
 219     //***********
 220     //XHyphenator
 221     //***********
 222     public XHyphenatedWord hyphenate(
 223             String aWord, Locale aLocale,
 224             short nMaxLeading, PropertyValue[] aProperties )
 225         throws com.sun.star.uno.RuntimeException,
 226                IllegalArgumentException
 227     {
 228         if (IsEqual( aLocale, new Locale() ) || aWord.length() == 0)
 229             return null;
 230
 231         // linguistic is currently not allowed to throw exceptions
 232         // thus we return null fwhich means 'word cannot be hyphenated'
 233         if (!hasLocale( aLocale ))
 234             return null;
 235
 236         // get values of relevant properties that may be used.
 237         //! The values for 'IsIgnoreControlCharacters' and 'IsUseDictionaryList'
 238         //! are handled by the dispatcher! Thus there is no need to access
 239         //! them here.
 240         boolean bIsIgnoreControlCharacters  = GetValueToUse( "IsIgnoreControlCharacters", true, aProperties );
 241         boolean bIsUseDictionaryList        = GetValueToUse( "IsUseDictionaryList", true, aProperties );
 242         boolean bIsGermanPreReform          = GetValueToUse( "IsGermanPreReform", false, aProperties );
 243         short   nHyphMinLeading             = GetValueToUse( "HyphMinLeading", (short)2, aProperties );
 244         short   nHyphMinTrailing            = GetValueToUse( "HyphMinTrailing", (short)2, aProperties );
 245         short   nHyphMinWordLen             = GetValueToUse( "HyphMinWordLength", (short)5, aProperties );
 246
 247         XHyphenatedWord xRes = null;
 248
 249         if (aWord.length() >= nHyphMinWordLen)
 250         {
 251             String  aHyphenatedWord = aWord;
 252             short   nHyphenationPos = -1;
 253             short   nHyphenPos = -1;
 254
 255             //!! This code needs to be replaced by code calling the actual
 256             //!! implementation of your hyphenator
 257             if (IsEqual( aLocale, new Locale( "de", "DE", "" ) ) )
 258             {
 259                 if (bIsGermanPreReform && aWord.equals( "Schiffahrt" ))
 260                 {
 261                     // Note: there is only one position where the word
 262                     // can be hyphenated...
 263
 264                     aHyphenatedWord = "Schifffahrt";
 265                     nHyphenationPos = 4;
 266                     nHyphenPos = 5;
 267                 }
 268                 else if (!bIsGermanPreReform && aWord.equals( "Schifffahrt" ))
 269                 {
 270                     nHyphenationPos = nHyphenPos = 5;
 271                 }
 272             }
 273             else if (IsEqual( aLocale, new Locale( "en", "US", "" ) ) )
 274             {
 275                 int nLast = aWord.length() - 1 - nHyphMinTrailing;
 276
 277                 if ( aWord.equals( "waterfall" ) )
 278                 {
 279                     if (4 <= nLast)
 280                         nHyphenationPos = nHyphenPos = 4;
 281                     else
 282                         nHyphenationPos = nHyphenPos = 1;
 283                 }
 284                 else if ( aWord.equals( "driving" ) )
 285                 {
 286                     nHyphenationPos = nHyphenPos = 3;
 287                 }
 288             }
 289
 290             // check if hyphenation pos is valid,
 291             // a value of -1 indicates that hyphenation is not possible
 292             if (  nHyphenationPos != -1 &&
 293                 !(nHyphenationPos <  nHyphMinLeading) &&
 294                 !(nHyphenationPos >= aWord.length() - nHyphMinTrailing))
 295             {
 296                 xRes = new XHyphenatedWord_impl(aWord, aLocale,
 297                                 nHyphenationPos, aHyphenatedWord, nHyphenPos);
 298             }
 299         }
 300         return xRes;
 301     }
 302
 303     public XHyphenatedWord queryAlternativeSpelling(
 304             String aWord, Locale aLocale,
 305             short nIndex, PropertyValue[] aProperties )
 306         throws com.sun.star.uno.RuntimeException,
 307                IllegalArgumentException
 308     {
 309         if (IsEqual( aLocale, new Locale() ) || aWord.length() == 0)
 310             return null;
 311
 312         // linguistic is currently not allowed to throw exceptions
 313         // thus we return null which means 'word cannot be hyphenated'
 314         if (!hasLocale( aLocale ))
 315             return null;
 316
 317         // get values of relevant properties that may be used.
 318         //! The values for 'IsIgnoreControlCharacters' and 'IsUseDictionaryList'
 319         //! are handled by the dispatcher! Thus there is no need to access
 320         //! them here.
 321         boolean bIsIgnoreControlCharacters  = GetValueToUse( "IsIgnoreControlCharacters", true, aProperties );
 322         boolean bIsUseDictionaryList        = GetValueToUse( "IsUseDictionaryList", true, aProperties );
 323         boolean bIsGermanPreReform          = GetValueToUse( "IsGermanPreReform", false, aProperties );
 324         short   nHyphMinLeading             = GetValueToUse( "HyphMinLeading", (short)2, aProperties );
 325         short   nHyphMinTrailing            = GetValueToUse( "HyphMinTrailing", (short)2, aProperties );
 326         short   nHyphMinWordLen             = GetValueToUse( "HyphMinWordLength", (short)5, aProperties );
 327
 328         XHyphenatedWord xRes = null;
 329
 330         //!! This code needs to be replaced by code calling the actual
 331         //!! implementation of your hyphenator
 332         if ( IsEqual( aLocale, new Locale( "de", "DE", "" ) ) )
 333         {
 334             // there is an alternative spelling only when the
 335             // word is hyphenated between the "ff" and old german spelling
 336             // is set.
 337             if (aWord.equals( "Schiffahrt" ) &&
 338                 bIsGermanPreReform && nIndex == 4)
 339             {
 340                 xRes = new XHyphenatedWord_impl(aWord, aLocale,
 341                               (short)4, "Schifffahrt", (short)5 );
 342             }
 343         }
 344         else if ( IsEqual( aLocale, new Locale( "en", "US", "" ) ) )
 345         {
 346             // There are no alternative spellings in the English language
 347         }
 348
 349         return xRes;
 350     }
 351
 352     public XPossibleHyphens createPossibleHyphens(
 353             String aWord, Locale aLocale,
 354             PropertyValue[] aProperties )
 355         throws com.sun.star.uno.RuntimeException,
 356                IllegalArgumentException
 357     {
 358         if (IsEqual( aLocale, new Locale() ) || aWord.length() == 0)
 359             return null;
 360
 361         // linguistic is currently not allowed to throw exceptions
 362         // thus we return null which means 'word cannot be hyphenated'
 363         if (!hasLocale( aLocale ))
 364             return null;
 365
 366         // get values of relevant properties that may be used.
 367         //! The values for 'IsIgnoreControlCharacters' and 'IsUseDictionaryList'
 368         //! are handled by the dispatcher! Thus there is no need to access
 369         //! them here.
 370         boolean bIsIgnoreControlCharacters  = GetValueToUse( "IsIgnoreControlCharacters", true, aProperties );
 371         boolean bIsUseDictionaryList        = GetValueToUse( "IsUseDictionaryList", true, aProperties );
 372         boolean bIsGermanPreReform          = GetValueToUse( "IsGermanPreReform", false, aProperties );
 373         short   nHyphMinLeading             = GetValueToUse( "HyphMinLeading", (short)2, aProperties );
 374         short   nHyphMinTrailing            = GetValueToUse( "HyphMinTrailing", (short)2, aProperties );
 375         short   nHyphMinWordLen             = GetValueToUse( "HyphMinWordLength", (short)5, aProperties );
 376
 377         XPossibleHyphens xRes = null;
 378
 379         //!! This code needs to be replaced by code calling the actual
 380         //!! implementation of your hyphenator
 381         if ( IsEqual( aLocale, new Locale( "de", "DE", "" ) ) )
 382         {
 383             if (bIsGermanPreReform && aWord.equals( "Schiffahrt" ))
 384             {
 385                 short aPos[] = new short[] { (short) 4 };
 386                 xRes = new XPossibleHyphens_impl(aWord, aLocale,
 387                             "Schiff=fahrt", aPos);
 388             }
 389             else if (!bIsGermanPreReform && aWord.equals( "Schifffahrt" ))
 390             {
 391                 short aPos[] = new short[] { (short) 5 };
 392                 xRes = new XPossibleHyphens_impl(aWord, aLocale,
 393                             "Schiff=fahrt", aPos);
 394             }
 395         }
 396         else if ( IsEqual( aLocale, new Locale( "en", "US", "" ) ) )
 397         {
 398             if ( aWord.equals( "waterfall" ) )
 399             {
 400                 short aPos[] = new short[]
 401                         { (short) 1, (short) 4 };
 402                 xRes = new XPossibleHyphens_impl(aWord, aLocale,
 403                             "wa=ter=fall", aPos);
 404             }
 405             else if ( aWord.equals( "driving" ) )
 406             {
 407                 short aPos[] = new short[]
 408                         { (short) 3 };
 409                 xRes = new XPossibleHyphens_impl(aWord, aLocale,
 410                             "driv=ing", aPos);
 411             }
 412         }
 413
 414         return xRes;
 415     }
 416
 417     //*****************************
 418     //XLinguServiceEventBroadcaster
 419     //*****************************
 420     public boolean addLinguServiceEventListener (
 421             XLinguServiceEventListener xLstnr )
 422         throws com.sun.star.uno.RuntimeException
 423     {
 424         boolean bRes = false;
 425         if (!bDisposing && xLstnr != null)
 426             bRes = aPropChgHelper.addLinguServiceEventListener( xLstnr );
 427         return bRes;
 428     }
 429
 430     public boolean removeLinguServiceEventListener(
 431             XLinguServiceEventListener xLstnr )
 432         throws com.sun.star.uno.RuntimeException
 433     {
 434         boolean bRes = false;
 435         if (!bDisposing && xLstnr != null)
 436             bRes = aPropChgHelper.removeLinguServiceEventListener( xLstnr );
 437         return bRes;
 438     }
 439
 440     //********************
 441     // XServiceDisplayName
 442     //********************
 443     public String getServiceDisplayName( Locale aLocale )
 444         throws com.sun.star.uno.RuntimeException
 445     {
 446         return "Java Samples";
 447     }
 448
 449     //****************
 450     // XInitialization
 451     //****************
 452     public void initialize( Object[] aArguments )
 453         throws com.sun.star.uno.Exception,
 454                com.sun.star.uno.RuntimeException
 455     {
 456         int nLen = aArguments.length;
 457         if (2 == nLen)
 458         {
 459             XPropertySet xPropSet = (XPropertySet)UnoRuntime.queryInterface(
 460                                          XPropertySet.class, aArguments[0]);
 461             // start listening to property changes
 462             aPropChgHelper.AddAsListenerTo( xPropSet );
 463         }
 464     }
 465
 466
 467     //*************
 468     // XServiceInfo
 469     //*************
 470     public boolean supportsService( String aServiceName )
 471         throws com.sun.star.uno.RuntimeException
 472     {
 473         String[] aServices = getSupportedServiceNames_Static();
 474         int i, nLength = aServices.length;
 475         boolean bResult = false;
 476
 477         for( i = 0; !bResult && i < nLength; ++i )
 478             bResult = aServiceName.equals( aServices[ i ] );
 479
 480         return bResult;
 481     }
 482
 483     public String getImplementationName()
 484         throws com.sun.star.uno.RuntimeException
 485     {
 486         return _aSvcImplName;
 487     }
 488
 489     public String[] getSupportedServiceNames()
 490         throws com.sun.star.uno.RuntimeException
 491     {
 492         return getSupportedServiceNames_Static();
 493     }
 494
 495     // __________ static things __________
 496
 497     public static String _aSvcImplName = "com.sun.star.linguistic2.JavaSamples.SampleHyphenator";
 498
 499     public static String[] getSupportedServiceNames_Static()
 500     {
 501         String[] aResult = { "com.sun.star.linguistic2.Hyphenator" };
 502         return aResult;
 503     }
 504
 505
 506     /**
 507      * Returns a factory for creating the service.
 508      * This method is called by the <code>JavaLoader</code>
 509      * <p>
 510      * @return  returns a <code>XSingleServiceFactory</code> for creating the component
 511      * @param   implName     the name of the implementation for which a service is desired
 512      * @param   multiFactory the service manager to be used if needed
 513      * @param   regKey       the registryKey
 514      * @see                  com.sun.star.comp.loader.JavaLoader
 515      */
 516     public static XSingleServiceFactory __getServiceFactory(
 517         String aImplName,
 518         XMultiServiceFactory xMultiFactory,
 519         com.sun.star.registry.XRegistryKey xRegKey )
 520     {
 521         XSingleServiceFactory xSingleServiceFactory = null;
 522         if( aImplName.equals( _aSvcImplName ) )
 523         {
 524             xSingleServiceFactory = new OneInstanceFactory(
 525                     SampleHyphenator.class, _aSvcImplName,
 526                     getSupportedServiceNames_Static(),
 527                     xMultiFactory );
 528         }
 529         return xSingleServiceFactory;
 530     }
 531
 532     /**
 533      * Writes the service information into the given registry key.
 534      * This method is called by the <code>JavaLoader</code>
 535      * <p>
 536      * @return  returns true if the operation succeeded
 537      * @param   xRegKey       the registryKey
 538      * @see                  com.sun.star.comp.loader.JavaLoader
 539      */
 540     public static boolean __writeRegistryServiceInfo(
 541             com.sun.star.registry.XRegistryKey xRegKey )
 542     {
 543         boolean bResult = true;
 544         String[] aServices = getSupportedServiceNames_Static();
 545         int i, nLength = aServices.length;
 546         for( i = 0; i < nLength; ++i )
 547         {
 548             bResult = bResult && com.sun.star.comp.loader.FactoryHelper.writeRegistryServiceInfo(
 549                 _aSvcImplName, aServices[i], xRegKey );
 550         }
 551         return bResult;
 552     }
 553 }
 554