Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: i18n ::
interface XExtendedIndexEntrySupplier
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XIndexEntrySupplier
          |
          +-XExtendedIndexEntrySupplier
Description This interface provides information for creating "Table of Index" It is derived from XIndexEntrySupplier and provides following additional functionalities. Provide supported language/locale list. Provide supported algorithm list. Provide phonetic entry support for CJK languge. Provide method to compare index entry. Since version OpenOffice.org 1.1.1 Developers Guide 6.2.2 Office Development - Common Application Features - Internationalization - Overview and Using the API - XExtendedIndexEntrySupplier

Methods' Summary
getLocaleList | Returns locale list for which the IndexEntrySupplier provides service.
getAlgorithmList | Returns index algorithm list for specific locale
usePhoneticEntry | Checks if Phonetic Entry should be used for the locale.
getPhoneticCandidate | Returns phonetic candidate for index entry for the locale.
loadAlgorithm | Loads index algorithm for the locale.
getIndexKey | Returns index key.
compareIndexEntry | Compares index entries

Methods' Details
getLocaleList
sequence< ::com::sun::star::lang::Locale > getLocaleList(); |  |
Description Returns locale list for which the IndexEntrySupplier provides service.
getAlgorithmList
sequence< string > getAlgorithmList( | [in] ::com::sun::star::lang::Locale | aLocale );
Description Returns index algorithm list for specific locale
usePhoneticEntry
boolean usePhoneticEntry( | [in] ::com::sun::star::lang::Locale | aLocale );
Description Checks if Phonetic Entry should be used for the locale.
getPhoneticCandidate
string getPhoneticCandidate( | [in] string [in] ::com::sun::star::lang::Locale | aIndexEntry, aLocale );
Description Returns phonetic candidate for index entry for the locale.
loadAlgorithm
boolean loadAlgorithm( | [in] ::com::sun::star::lang::Locale [in] string [in] long | aLocale, aIndexAlgorithm, nCollatorOptions );
Description Loads index algorithm for the locale. Parameter aIndexAlgorithm Index algorithm to be loaded. Parameter nCollatorOptions Sorting option of CollatorOptions for comparing index entries Returns true if algorithm successfully loaded, false else.
getIndexKey
string getIndexKey( | [in] string [in] string [in] ::com::sun::star::lang::Locale | aIndexEntry, aPhoneticEntry, aLocale );
Description Returns index key. Note that loadAlgorithm should be called before calling this function. Parameter aIndexEntry Index entry Parameter aPhoneticEntry Phonetic entry Parameter aLocale Language attribute for index and phonetic entry. aLocale and the locale in loadAlgorithm may be different. In the case they are different, phonetic entry will not be used in the index key generation.
compareIndexEntry
short compareIndexEntry( | [in] string [in] string [in] ::com::sun::star::lang::Locale [in] string [in] string [in] ::com::sun::star::lang::Locale | aIndexEntry1, aPhoneticEntry1, aLocale1, aIndexEntry2, aPhoneticEntry2, aLocale2 );
Description Compares index entries Note that loadAlgorithm should be called before calling this function. Parameter aIndexEntry1 Parameter aIndexEntry2 Index entries to be compared Parameter aPhoneticEntry1 Parameter aPhoneticEntry2 Phonetic entries to be compared Parameter aLocale1 Parameter aLocale2 Language attribute for index and phonetic entry. aLocale and the locale in loadAlgorithm may be different. In the case they are different, phonetic entry will not be used in the index key generation.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.