ICU 49.1.1  49.1.1
sortkey.h
Go to the documentation of this file.
00001 /*
00002  *****************************************************************************
00003  * Copyright (C) 1996-2011, International Business Machines Corporation and others.
00004  * All Rights Reserved.
00005  *****************************************************************************
00006  *
00007  * File sortkey.h
00008  *
00009  * Created by: Helena Shih
00010  *
00011  * Modification History:
00012  *
00013  *  Date         Name          Description
00014  *
00015  *  6/20/97     helena      Java class name change.
00016  *  8/18/97     helena      Added internal API documentation.
00017  *  6/26/98     erm         Changed to use byte arrays and memcmp.
00018  *****************************************************************************
00019  */
00020 
00021 #ifndef SORTKEY_H
00022 #define SORTKEY_H
00023 
00024 #include "unicode/utypes.h"
00025 
00031 #if !UCONFIG_NO_COLLATION
00032 #ifndef U_HIDE_DEPRECATED_API
00033 
00034 #include "unicode/uobject.h"
00035 #include "unicode/unistr.h"
00036 #include "unicode/coll.h"
00037 
00038 U_NAMESPACE_BEGIN
00039 
00040 /* forward declaration */
00041 class RuleBasedCollator;
00042 
00097 class U_I18N_API CollationKey : public UObject {
00098 public:
00106     CollationKey();
00107 
00108 
00115     CollationKey(const  uint8_t*    values,
00116                 int32_t     count);
00117 
00123     CollationKey(const CollationKey& other);
00124 
00129     virtual ~CollationKey();
00130 
00136     const   CollationKey&   operator=(const CollationKey& other);
00137 
00144     UBool                   operator==(const CollationKey& source) const;
00145 
00152     UBool                   operator!=(const CollationKey& source) const;
00153 
00154 
00161     UBool                   isBogus(void) const;
00162 
00172     const    uint8_t*       getByteArray(int32_t& count) const;
00173 
00174 #ifdef U_USE_COLLATION_KEY_DEPRECATES
00175 
00182     uint8_t*                toByteArray(int32_t& count) const;
00183 #endif
00184 
00194     Collator::EComparisonResult compareTo(const CollationKey& target) const;
00195 
00206     UCollationResult compareTo(const CollationKey& target, UErrorCode &status) const;
00207 
00228     int32_t                 hashCode(void) const;
00229 
00234     virtual UClassID getDynamicClassID() const;
00235 
00240     static UClassID U_EXPORT2 getStaticClassID();
00241 
00242 private:
00251     void adopt(uint8_t *values, int32_t capacity, int32_t count);
00255     void setLength(int32_t newLength);
00256 
00257     /*
00258     * Creates a collation key with a string.
00259     */
00260 
00267     CollationKey&           ensureCapacity(int32_t newSize);
00272     CollationKey&           setToBogus(void);
00277     CollationKey&           reset(void);
00278     
00282     friend  class           RuleBasedCollator;
00286     UBool                   fBogus;
00291     int32_t                 fCount;
00295     int32_t                 fCapacity;
00299     int32_t                 fHashCode;
00303     uint8_t*                fBytes;
00304 
00305 };
00306 
00307 inline UBool
00308 CollationKey::operator!=(const CollationKey& other) const
00309 {
00310     return !(*this == other);
00311 }
00312 
00313 inline UBool
00314 CollationKey::isBogus() const
00315 {
00316     return fBogus;
00317 }
00318 
00319 inline const uint8_t*
00320 CollationKey::getByteArray(int32_t &count) const
00321 {
00322     count = fCount;
00323     return fBytes;
00324 }
00325 
00326 U_NAMESPACE_END
00327 
00328 #endif  /* U_HIDE_DEPRECATED_API */
00329 #endif /* #if !UCONFIG_NO_COLLATION */
00330 
00331 #endif