HasSortOrder

CompareTextBySortOrder InstallInto IsTextSimilarBySortOrder MakeComparableBySortOrder

Attributes

Class HasSortOrder defines no new attributes.

Fields

Define Class HasSortOrder;
    mixes in with Object, HasLocale;
    
    // routines to compare the raw text of two text objects

    operation IsTextSimilarBySortOrder(a: HasText; b: HasText): Boolean, safe;
        // call to find out whether this sort order considers these two
        // text objects to be similar
        // implementation is based on CompareTextBySortOrder
        // override if you want a different (maybe more efficient) implementation
    operation CompareTextBySortOrder(a: HasText; b: HasText): SignedShort, safe, noMethod;
        // call to compare two text objects in this sort order.
        // Returns 0 if the text objects are identical,
        // negative values if a < b (sorts before),
        // positive values if a > b (sorts after).
        // Absolute value of return value indicates most relevant difference found:
        // 1 if there is a primary difference (such as difference in text length or
        //   between the characters 'A' and 'B')
        // 2 if there is only a secondary difference (such as between 'A' and 'a')
        // 3 or higher absolute values if the difference is even less relevant
    operation MakeComparableBySortOrder(a: HasText): Text, safe, noMethod;
        // returns copy of a with all characters normalized so that
        // IsTextSimilarBySortOrder(sortOrder, a, b) == IsTextIdentical(MakeComparableBySortOrder(sortOrder, a), MakeComparableBySortOrder(sortOrder, b))

    overrides InstallInto;
        // triggers resorting all alphabetical lists in the system
end class;